diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-02-01.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-02-01.json index fe46362b81..739fa32e39 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-02-01.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-02-01.json @@ -115,6 +115,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", @@ -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", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-10-01.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-10-01.json index 2dc8b57908..156d9dbc2c 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-10-01.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-10-01.json @@ -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", @@ -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", @@ -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", @@ -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", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-11-15.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-11-15.json index 5d43f39b88..25bfa48548 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2023-11-15.json @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2024-05-30.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2024-05-30.json index 60f30c2ce9..c9b16024c6 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2024-05-30.json @@ -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", @@ -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", @@ -103,6 +115,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -116,6 +134,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -139,6 +163,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -177,6 +207,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -200,6 +236,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", @@ -213,6 +255,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", @@ -328,6 +376,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", @@ -483,6 +545,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}/search/deployment", "httpMethod": "DELETE", @@ -494,6 +570,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -501,6 +583,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -512,6 +622,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -662,6 +778,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", @@ -681,6 +811,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -699,6 +835,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2024-08-05.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2024-08-05.json index 7885cb561b..a17b234746 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-01-01_2024-08-05.json @@ -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", @@ -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", @@ -103,6 +115,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -116,6 +134,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -139,6 +163,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -177,6 +207,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -200,6 +236,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", @@ -213,6 +255,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", @@ -231,6 +279,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -260,6 +314,12 @@ "operationId": "createCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -308,12 +368,32 @@ } ] }, + { + "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", "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -343,6 +423,12 @@ "operationId": "updateCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -402,6 +488,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -425,6 +517,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -448,6 +546,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -522,12 +626,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -541,6 +721,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -553,6 +739,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}/search/deployment", "httpMethod": "DELETE", @@ -564,6 +764,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -571,6 +777,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -582,6 +816,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -732,6 +972,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", @@ -751,6 +1005,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -769,6 +1029,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2023-10-01.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2023-10-01.json index d7d69d80df..f652926771 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2023-10-01.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2023-10-01.json @@ -5,6 +5,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", @@ -18,6 +24,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", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2023-11-15.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2023-11-15.json index e6e4c9e081..3e837fcc24 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2023-11-15.json @@ -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", @@ -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", @@ -90,6 +102,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", @@ -103,6 +121,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", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2024-05-30.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2024-05-30.json index 953f8e59de..02ad3bc994 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2024-05-30.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -187,6 +223,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", @@ -200,6 +242,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", @@ -275,6 +323,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -282,6 +336,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -293,6 +375,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -462,6 +550,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -480,6 +574,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2024-08-05.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2024-08-05.json index 9898f971b4..f8851d7c7a 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-02-01_2024-08-05.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -187,6 +223,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", @@ -200,6 +242,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", @@ -218,6 +266,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -286,6 +340,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -384,6 +444,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -452,6 +518,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -555,6 +627,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -578,6 +656,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -601,6 +685,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -675,12 +765,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -694,6 +860,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -717,6 +889,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -724,6 +902,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -735,6 +941,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -904,6 +1116,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -922,6 +1140,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-10-01_2023-11-15.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-10-01_2023-11-15.json index 0fc0cd1847..f9728bad5d 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-10-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-10-01_2023-11-15.json @@ -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", @@ -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", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-10-01_2024-05-30.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-10-01_2024-05-30.json index f137518500..bcae4a4af3 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-10-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-10-01_2024-05-30.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -244,6 +280,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -251,6 +293,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -262,6 +332,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -431,6 +507,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -449,6 +531,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-10-01_2024-08-05.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-10-01_2024-08-05.json index 5634178f5f..cd4162a67e 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-10-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-10-01_2024-08-05.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -187,6 +223,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -255,6 +297,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -353,6 +401,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -421,6 +475,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -524,6 +584,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -547,6 +613,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -570,6 +642,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -644,12 +722,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -663,6 +817,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -686,6 +846,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -693,6 +859,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -704,6 +898,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -873,6 +1073,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -891,6 +1097,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-11-15_2024-05-30.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-11-15_2024-05-30.json index 520e4f3f0a..8129561f12 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-11-15_2024-05-30.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-11-15_2024-05-30.json @@ -5,6 +5,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -18,6 +24,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -41,6 +53,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -79,6 +97,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -107,6 +131,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -114,6 +144,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -125,6 +183,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -255,6 +319,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -273,6 +343,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-11-15_2024-08-05.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-11-15_2024-08-05.json index 7597685871..097a36e4f0 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2023-11-15_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2023-11-15_2024-08-05.json @@ -5,6 +5,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -18,6 +24,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -41,6 +53,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -79,6 +97,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -102,6 +126,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -170,6 +200,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -268,6 +304,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -336,6 +378,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -439,6 +487,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -462,6 +516,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -485,6 +545,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -507,12 +573,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -526,6 +668,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -549,6 +697,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -556,6 +710,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -567,6 +749,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -697,6 +885,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -715,6 +909,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/2024-05-30_2024-08-05.json b/tools/cli/test/data/changelog/new-api-preview-version/output/2024-05-30_2024-08-05.json index 2cb25811ad..5c337e1f4e 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/2024-05-30_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/2024-05-30_2024-08-05.json @@ -5,6 +5,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -73,6 +79,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -171,6 +183,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -239,6 +257,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -342,6 +366,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -365,6 +395,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -388,6 +424,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -410,12 +452,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -429,6 +547,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/changelog-all.json b/tools/cli/test/data/changelog/new-api-preview-version/output/changelog-all.json index 786fde0761..6b550f4276 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/changelog-all.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/changelog-all.json @@ -1,6 +1,6 @@ [ { - "date": "2026-04-15", + "date": "2026-07-09", "paths": [ { "path": "/api/atlas/v2/groups/{groupId}/clusters", @@ -9,6 +9,12 @@ { "version": "2024-08-05", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -62,6 +68,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "listClusters", @@ -84,6 +105,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -177,6 +204,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "createCluster", @@ -189,6 +231,12 @@ { "version": "2024-08-05", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -242,6 +290,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "getCluster", @@ -264,6 +327,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -357,6 +426,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "updateCluster", @@ -374,6 +458,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -387,6 +477,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "deleteAllBackupSchedules", @@ -404,6 +509,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -417,6 +528,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "getBackupSchedule", @@ -434,6 +560,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -457,140 +589,292 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "updateBackupSchedule", "tag": "Cloud Backups" }, { - "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", "httpMethod": "GET", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "getClusterAdvancedConfiguration", - "tag": "Clusters" + "operationId": "getManagedNamespace", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", - "httpMethod": "PATCH", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false - }, - { - "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", - "changeCode": "request-property-removed", - "backwardCompatible": false + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "updateClusterAdvancedConfiguration", - "tag": "Clusters" + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", "httpMethod": "POST", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `pipeline` request property `type` changed from `string` to `array`", - "changeCode": "request-property-type-changed", - "backwardCompatible": false - }, - { - "change": "the `pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", - "backwardCompatible": false - }, + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ], + "stabilityLevel": "stable", + "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ { - "change": "added the optional property 'options' to the response with the '200' status", - "changeCode": "response-optional-property-added", - "backwardCompatible": true - }, + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" + } + ], + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "versions": [ + { + "version": "2024-08-05", + "changes": [ { - "change": "removed the optional property 'dlq' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false - }, + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ], + "stabilityLevel": "stable", + "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ { - "change": "removed the request property 'dlq'", - "changeCode": "request-property-removed", - "backwardCompatible": false - }, + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" + } + ], + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-08-05", + "changes": [ { - "change": "added the new optional request property 'options'", - "changeCode": "new-optional-request-property", - "backwardCompatible": true + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "createStreamProcessor", - "tag": "Streams" + "operationId": "createManagedNamespace", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", + "changeCode": "response-optional-property-removed", "backwardCompatible": false } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "getStreamProcessor", - "tag": "Streams" + "operationId": "getClusterAdvancedConfiguration", + "tag": "Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", - "httpMethod": "GET", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "PATCH", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `results/items/pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", + "changeCode": "response-optional-property-removed", + "backwardCompatible": false + }, + { + "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", + "changeCode": "request-property-removed", "backwardCompatible": false } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "listStreamProcessors", - "tag": "Streams" + "operationId": "updateClusterAdvancedConfiguration", + "tag": "Clusters" } ] }, diff --git a/tools/cli/test/data/changelog/new-api-preview-version/output/changelog.json b/tools/cli/test/data/changelog/new-api-preview-version/output/changelog.json index 786fde0761..6b550f4276 100644 --- a/tools/cli/test/data/changelog/new-api-preview-version/output/changelog.json +++ b/tools/cli/test/data/changelog/new-api-preview-version/output/changelog.json @@ -1,6 +1,6 @@ [ { - "date": "2026-04-15", + "date": "2026-07-09", "paths": [ { "path": "/api/atlas/v2/groups/{groupId}/clusters", @@ -9,6 +9,12 @@ { "version": "2024-08-05", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -62,6 +68,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "listClusters", @@ -84,6 +105,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -177,6 +204,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "createCluster", @@ -189,6 +231,12 @@ { "version": "2024-08-05", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -242,6 +290,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "getCluster", @@ -264,6 +327,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -357,6 +426,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "updateCluster", @@ -374,6 +458,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -387,6 +477,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "deleteAllBackupSchedules", @@ -404,6 +509,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -417,6 +528,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "getBackupSchedule", @@ -434,6 +560,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -457,140 +589,292 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "updateBackupSchedule", "tag": "Cloud Backups" }, { - "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", "httpMethod": "GET", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "getClusterAdvancedConfiguration", - "tag": "Clusters" + "operationId": "getManagedNamespace", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", - "httpMethod": "PATCH", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false - }, - { - "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", - "changeCode": "request-property-removed", - "backwardCompatible": false + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "updateClusterAdvancedConfiguration", - "tag": "Clusters" + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", "httpMethod": "POST", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `pipeline` request property `type` changed from `string` to `array`", - "changeCode": "request-property-type-changed", - "backwardCompatible": false - }, - { - "change": "the `pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", - "backwardCompatible": false - }, + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ], + "stabilityLevel": "stable", + "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ { - "change": "added the optional property 'options' to the response with the '200' status", - "changeCode": "response-optional-property-added", - "backwardCompatible": true - }, + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" + } + ], + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "versions": [ + { + "version": "2024-08-05", + "changes": [ { - "change": "removed the optional property 'dlq' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false - }, + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ], + "stabilityLevel": "stable", + "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ { - "change": "removed the request property 'dlq'", - "changeCode": "request-property-removed", - "backwardCompatible": false - }, + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" + } + ], + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-08-05", + "changes": [ { - "change": "added the new optional request property 'options'", - "changeCode": "new-optional-request-property", - "backwardCompatible": true + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "createStreamProcessor", - "tag": "Streams" + "operationId": "createManagedNamespace", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", + "changeCode": "response-optional-property-removed", "backwardCompatible": false } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "getStreamProcessor", - "tag": "Streams" + "operationId": "getClusterAdvancedConfiguration", + "tag": "Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", - "httpMethod": "GET", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "PATCH", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `results/items/pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", + "changeCode": "response-optional-property-removed", + "backwardCompatible": false + }, + { + "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", + "changeCode": "request-property-removed", "backwardCompatible": false } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "listStreamProcessors", - "tag": "Streams" + "operationId": "updateClusterAdvancedConfiguration", + "tag": "Clusters" } ] }, diff --git a/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2023-02-01.json b/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2023-02-01.json index fe46362b81..739fa32e39 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2023-02-01.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2023-02-01.json @@ -115,6 +115,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", @@ -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", diff --git a/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2023-10-01.json b/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2023-10-01.json index 2dc8b57908..156d9dbc2c 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2023-10-01.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2023-10-01.json @@ -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", @@ -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", @@ -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", @@ -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", diff --git a/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2023-11-15.json b/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2023-11-15.json index 5d43f39b88..25bfa48548 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2023-11-15.json @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", diff --git a/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2024-05-30.json b/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2024-05-30.json index 60f30c2ce9..c9b16024c6 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2024-05-30.json @@ -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", @@ -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", @@ -103,6 +115,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -116,6 +134,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -139,6 +163,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -177,6 +207,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -200,6 +236,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", @@ -213,6 +255,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", @@ -328,6 +376,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", @@ -483,6 +545,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}/search/deployment", "httpMethod": "DELETE", @@ -494,6 +570,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -501,6 +583,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -512,6 +622,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -662,6 +778,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", @@ -681,6 +811,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -699,6 +835,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2024-08-05.json b/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2024-08-05.json index 7885cb561b..a17b234746 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2023-01-01_2024-08-05.json @@ -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", @@ -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", @@ -103,6 +115,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -116,6 +134,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -139,6 +163,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -177,6 +207,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -200,6 +236,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", @@ -213,6 +255,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", @@ -231,6 +279,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -260,6 +314,12 @@ "operationId": "createCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -308,12 +368,32 @@ } ] }, + { + "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", "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -343,6 +423,12 @@ "operationId": "updateCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -402,6 +488,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -425,6 +517,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -448,6 +546,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -522,12 +626,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -541,6 +721,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -553,6 +739,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}/search/deployment", "httpMethod": "DELETE", @@ -564,6 +764,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -571,6 +777,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -582,6 +816,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -732,6 +972,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", @@ -751,6 +1005,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -769,6 +1029,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2023-10-01.json b/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2023-10-01.json index d7d69d80df..f652926771 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2023-10-01.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2023-10-01.json @@ -5,6 +5,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", @@ -18,6 +24,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", diff --git a/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2023-11-15.json b/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2023-11-15.json index e6e4c9e081..3e837fcc24 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2023-11-15.json @@ -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", @@ -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", @@ -90,6 +102,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", @@ -103,6 +121,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", diff --git a/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2024-05-30.json b/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2024-05-30.json index 953f8e59de..02ad3bc994 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2024-05-30.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -187,6 +223,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", @@ -200,6 +242,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", @@ -275,6 +323,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -282,6 +336,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -293,6 +375,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -462,6 +550,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -480,6 +574,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2024-08-05.json b/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2024-08-05.json index 9898f971b4..f8851d7c7a 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2023-02-01_2024-08-05.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -187,6 +223,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", @@ -200,6 +242,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", @@ -218,6 +266,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -286,6 +340,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -384,6 +444,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -452,6 +518,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -555,6 +627,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -578,6 +656,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -601,6 +685,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -675,12 +765,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -694,6 +860,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -717,6 +889,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -724,6 +902,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -735,6 +941,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -904,6 +1116,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -922,6 +1140,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-version/output/2023-10-01_2023-11-15.json b/tools/cli/test/data/changelog/new-api-version/output/2023-10-01_2023-11-15.json index 0fc0cd1847..f9728bad5d 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2023-10-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2023-10-01_2023-11-15.json @@ -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", @@ -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", diff --git a/tools/cli/test/data/changelog/new-api-version/output/2023-10-01_2024-05-30.json b/tools/cli/test/data/changelog/new-api-version/output/2023-10-01_2024-05-30.json index f137518500..bcae4a4af3 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2023-10-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2023-10-01_2024-05-30.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -244,6 +280,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -251,6 +293,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -262,6 +332,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -431,6 +507,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -449,6 +531,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-version/output/2023-10-01_2024-08-05.json b/tools/cli/test/data/changelog/new-api-version/output/2023-10-01_2024-08-05.json index 5634178f5f..cd4162a67e 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2023-10-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2023-10-01_2024-08-05.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -187,6 +223,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -255,6 +297,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -353,6 +401,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -421,6 +475,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -524,6 +584,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -547,6 +613,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -570,6 +642,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -644,12 +722,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -663,6 +817,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -686,6 +846,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -693,6 +859,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -704,6 +898,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -873,6 +1073,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -891,6 +1097,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-version/output/2023-11-15_2024-05-30.json b/tools/cli/test/data/changelog/new-api-version/output/2023-11-15_2024-05-30.json index 520e4f3f0a..8129561f12 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2023-11-15_2024-05-30.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2023-11-15_2024-05-30.json @@ -5,6 +5,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -18,6 +24,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -41,6 +53,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -79,6 +97,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -107,6 +131,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -114,6 +144,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -125,6 +183,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -255,6 +319,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -273,6 +343,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-version/output/2023-11-15_2024-08-05.json b/tools/cli/test/data/changelog/new-api-version/output/2023-11-15_2024-08-05.json index 7597685871..097a36e4f0 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2023-11-15_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2023-11-15_2024-08-05.json @@ -5,6 +5,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -18,6 +24,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -41,6 +53,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -79,6 +97,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -102,6 +126,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -170,6 +200,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -268,6 +304,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -336,6 +378,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -439,6 +487,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -462,6 +516,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -485,6 +545,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -507,12 +573,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -526,6 +668,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -549,6 +697,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -556,6 +710,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -567,6 +749,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -697,6 +885,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -715,6 +909,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-version/output/2024-05-30_2024-08-05.json b/tools/cli/test/data/changelog/new-api-version/output/2024-05-30_2024-08-05.json index 2cb25811ad..5c337e1f4e 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/2024-05-30_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-api-version/output/2024-05-30_2024-08-05.json @@ -5,6 +5,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -73,6 +79,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -171,6 +183,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -239,6 +257,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -342,6 +366,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -365,6 +395,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -388,6 +424,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -410,12 +452,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -429,6 +547,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", diff --git a/tools/cli/test/data/changelog/new-api-version/output/changelog-all.json b/tools/cli/test/data/changelog/new-api-version/output/changelog-all.json index 786fde0761..6b550f4276 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/changelog-all.json +++ b/tools/cli/test/data/changelog/new-api-version/output/changelog-all.json @@ -1,6 +1,6 @@ [ { - "date": "2026-04-15", + "date": "2026-07-09", "paths": [ { "path": "/api/atlas/v2/groups/{groupId}/clusters", @@ -9,6 +9,12 @@ { "version": "2024-08-05", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -62,6 +68,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "listClusters", @@ -84,6 +105,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -177,6 +204,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "createCluster", @@ -189,6 +231,12 @@ { "version": "2024-08-05", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -242,6 +290,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "getCluster", @@ -264,6 +327,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -357,6 +426,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "updateCluster", @@ -374,6 +458,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -387,6 +477,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "deleteAllBackupSchedules", @@ -404,6 +509,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -417,6 +528,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "getBackupSchedule", @@ -434,6 +560,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -457,140 +589,292 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "updateBackupSchedule", "tag": "Cloud Backups" }, { - "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", "httpMethod": "GET", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "getClusterAdvancedConfiguration", - "tag": "Clusters" + "operationId": "getManagedNamespace", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", - "httpMethod": "PATCH", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false - }, - { - "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", - "changeCode": "request-property-removed", - "backwardCompatible": false + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "updateClusterAdvancedConfiguration", - "tag": "Clusters" + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", "httpMethod": "POST", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `pipeline` request property `type` changed from `string` to `array`", - "changeCode": "request-property-type-changed", - "backwardCompatible": false - }, - { - "change": "the `pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", - "backwardCompatible": false - }, + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ], + "stabilityLevel": "stable", + "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ { - "change": "added the optional property 'options' to the response with the '200' status", - "changeCode": "response-optional-property-added", - "backwardCompatible": true - }, + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" + } + ], + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "versions": [ + { + "version": "2024-08-05", + "changes": [ { - "change": "removed the optional property 'dlq' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false - }, + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ], + "stabilityLevel": "stable", + "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ { - "change": "removed the request property 'dlq'", - "changeCode": "request-property-removed", - "backwardCompatible": false - }, + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" + } + ], + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-08-05", + "changes": [ { - "change": "added the new optional request property 'options'", - "changeCode": "new-optional-request-property", - "backwardCompatible": true + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "createStreamProcessor", - "tag": "Streams" + "operationId": "createManagedNamespace", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", + "changeCode": "response-optional-property-removed", "backwardCompatible": false } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "getStreamProcessor", - "tag": "Streams" + "operationId": "getClusterAdvancedConfiguration", + "tag": "Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", - "httpMethod": "GET", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "PATCH", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `results/items/pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", + "changeCode": "response-optional-property-removed", + "backwardCompatible": false + }, + { + "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", + "changeCode": "request-property-removed", "backwardCompatible": false } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "listStreamProcessors", - "tag": "Streams" + "operationId": "updateClusterAdvancedConfiguration", + "tag": "Clusters" } ] }, diff --git a/tools/cli/test/data/changelog/new-api-version/output/changelog.json b/tools/cli/test/data/changelog/new-api-version/output/changelog.json index 786fde0761..6b550f4276 100644 --- a/tools/cli/test/data/changelog/new-api-version/output/changelog.json +++ b/tools/cli/test/data/changelog/new-api-version/output/changelog.json @@ -1,6 +1,6 @@ [ { - "date": "2026-04-15", + "date": "2026-07-09", "paths": [ { "path": "/api/atlas/v2/groups/{groupId}/clusters", @@ -9,6 +9,12 @@ { "version": "2024-08-05", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -62,6 +68,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "listClusters", @@ -84,6 +105,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -177,6 +204,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "createCluster", @@ -189,6 +231,12 @@ { "version": "2024-08-05", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -242,6 +290,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "getCluster", @@ -264,6 +327,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -357,6 +426,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "updateCluster", @@ -374,6 +458,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -387,6 +477,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "deleteAllBackupSchedules", @@ -404,6 +509,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -417,6 +528,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "getBackupSchedule", @@ -434,6 +560,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -457,140 +589,292 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "updateBackupSchedule", "tag": "Cloud Backups" }, { - "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", "httpMethod": "GET", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "getClusterAdvancedConfiguration", - "tag": "Clusters" + "operationId": "getManagedNamespace", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", - "httpMethod": "PATCH", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false - }, - { - "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", - "changeCode": "request-property-removed", - "backwardCompatible": false + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "updateClusterAdvancedConfiguration", - "tag": "Clusters" + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", "httpMethod": "POST", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `pipeline` request property `type` changed from `string` to `array`", - "changeCode": "request-property-type-changed", - "backwardCompatible": false - }, - { - "change": "the `pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", - "backwardCompatible": false - }, + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ], + "stabilityLevel": "stable", + "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ { - "change": "added the optional property 'options' to the response with the '200' status", - "changeCode": "response-optional-property-added", - "backwardCompatible": true - }, + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" + } + ], + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "versions": [ + { + "version": "2024-08-05", + "changes": [ { - "change": "removed the optional property 'dlq' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false - }, + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ], + "stabilityLevel": "stable", + "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ { - "change": "removed the request property 'dlq'", - "changeCode": "request-property-removed", - "backwardCompatible": false - }, + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" + } + ], + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-08-05", + "changes": [ { - "change": "added the new optional request property 'options'", - "changeCode": "new-optional-request-property", - "backwardCompatible": true + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "createStreamProcessor", - "tag": "Streams" + "operationId": "createManagedNamespace", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", + "changeCode": "response-optional-property-removed", "backwardCompatible": false } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "getStreamProcessor", - "tag": "Streams" + "operationId": "getClusterAdvancedConfiguration", + "tag": "Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", - "httpMethod": "GET", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "PATCH", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `results/items/pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", + "changeCode": "response-optional-property-removed", + "backwardCompatible": false + }, + { + "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", + "changeCode": "request-property-removed", "backwardCompatible": false } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "listStreamProcessors", - "tag": "Streams" + "operationId": "updateClusterAdvancedConfiguration", + "tag": "Clusters" } ] }, diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2023-02-01.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2023-02-01.json index 630e1a6902..6ab9a33a6f 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2023-02-01.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2023-02-01.json @@ -125,6 +125,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", @@ -303,6 +317,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", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2023-10-01.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2023-10-01.json index 27d10c6e7d..9a58841bc6 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2023-10-01.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2023-10-01.json @@ -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", @@ -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", @@ -156,6 +168,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", @@ -334,6 +360,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", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2023-11-15.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2023-11-15.json index 9ed974a97b..6b23fc039f 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2023-11-15.json @@ -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", @@ -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", @@ -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", @@ -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", @@ -241,6 +265,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", @@ -471,6 +509,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", @@ -497,6 +549,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", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-05-30.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-05-30.json index a8afc7ac04..7d3c634007 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-05-30.json @@ -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", @@ -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", @@ -103,6 +115,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -116,6 +134,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -134,6 +158,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -162,6 +192,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -180,6 +216,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", @@ -193,6 +235,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", @@ -318,6 +366,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", @@ -548,6 +610,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}/search/deployment", "httpMethod": "DELETE", @@ -559,6 +635,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -566,6 +648,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -577,6 +673,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -753,6 +855,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", @@ -772,6 +888,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -790,6 +912,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-08-05.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-08-05.json index d56213868a..de5b3f3fe5 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-08-05.json @@ -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", @@ -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", @@ -103,6 +115,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -116,6 +134,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -134,6 +158,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -162,6 +192,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -180,6 +216,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", @@ -193,6 +235,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", @@ -211,6 +259,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -293,12 +347,32 @@ } ] }, + { + "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", "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -405,6 +479,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -428,6 +508,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -451,6 +537,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -525,6 +617,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -570,6 +732,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -583,6 +751,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -595,6 +769,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}/search/deployment", "httpMethod": "DELETE", @@ -606,6 +794,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -613,6 +807,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -624,6 +832,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -826,6 +1040,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", @@ -845,6 +1073,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -863,6 +1097,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-10-23.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-10-23.json index 17baf2d30f..434f015d8c 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-10-23.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-10-23.json @@ -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", @@ -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", @@ -103,6 +115,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -116,6 +134,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -134,6 +158,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -162,6 +192,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -180,6 +216,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", @@ -193,6 +235,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", @@ -211,6 +259,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -240,6 +294,12 @@ "operationId": "createCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -288,12 +348,32 @@ } ] }, + { + "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", "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -323,6 +403,12 @@ "operationId": "updateCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -395,6 +481,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -418,6 +510,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -441,6 +539,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -515,6 +619,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -560,6 +734,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -573,6 +753,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -585,6 +771,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}/search/deployment", "httpMethod": "DELETE", @@ -596,6 +796,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -603,6 +809,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -614,6 +834,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -816,6 +1042,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", @@ -835,6 +1075,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -853,6 +1099,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-11-13.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-11-13.json index 2f6d4074b4..6a0836fc38 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-11-13.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2024-11-13.json @@ -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", @@ -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", @@ -103,6 +115,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -116,6 +134,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -134,6 +158,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -162,6 +192,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -193,6 +229,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", @@ -206,6 +248,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", @@ -224,6 +272,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -253,6 +307,12 @@ "operationId": "createCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -301,12 +361,32 @@ } ] }, + { + "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", "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -336,6 +416,12 @@ "operationId": "updateCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -408,6 +494,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -431,6 +523,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -454,6 +552,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -528,6 +632,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -573,6 +747,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -586,6 +766,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -598,6 +784,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}/search/deployment", "httpMethod": "DELETE", @@ -609,6 +809,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -616,6 +822,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -627,6 +847,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -829,6 +1055,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", @@ -1004,6 +1244,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1022,6 +1268,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2025-02-19.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2025-02-19.json index 7c6534c6a6..e39711a492 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2025-02-19.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2025-02-19.json @@ -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", @@ -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", @@ -103,6 +115,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -116,6 +134,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -134,6 +158,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -162,6 +192,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -193,6 +229,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", @@ -206,6 +248,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", @@ -224,6 +272,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -253,6 +307,12 @@ "operationId": "createCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -301,12 +361,32 @@ } ] }, + { + "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", "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -336,6 +416,12 @@ "operationId": "updateCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -408,6 +494,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -431,6 +523,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -454,6 +552,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -528,6 +632,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -573,6 +747,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -586,6 +766,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -598,6 +784,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}/search/deployment", "httpMethod": "DELETE", @@ -609,6 +809,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -616,6 +822,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -627,6 +847,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -829,6 +1055,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", @@ -1004,6 +1244,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1022,6 +1268,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1591,6 +1843,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1653,6 +1911,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -1976,6 +2248,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -2062,6 +2340,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -2124,6 +2408,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2025-03-12.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2025-03-12.json index d04c43fd7a..cecd2d3ec2 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2025-03-12.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-01-01_2025-03-12.json @@ -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", @@ -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", @@ -103,6 +115,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -116,6 +134,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -134,6 +158,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -162,6 +192,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -193,6 +229,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", @@ -206,6 +248,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", @@ -224,6 +272,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -253,6 +307,12 @@ "operationId": "createCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -301,12 +361,32 @@ } ] }, + { + "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", "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -336,6 +416,12 @@ "operationId": "updateCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -408,6 +494,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -431,6 +523,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -454,6 +552,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -528,6 +632,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -573,6 +747,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -586,6 +766,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -598,6 +784,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}/search/deployment", "httpMethod": "DELETE", @@ -609,6 +809,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -616,6 +822,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2025-03-12 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -627,6 +861,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -829,6 +1069,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", @@ -1004,6 +1258,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1022,6 +1282,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1604,6 +1870,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1666,6 +1938,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -1989,6 +2275,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -2075,6 +2367,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -2137,6 +2435,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2023-10-01.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2023-10-01.json index d7d69d80df..f652926771 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2023-10-01.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2023-10-01.json @@ -5,6 +5,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", @@ -18,6 +24,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", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2023-11-15.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2023-11-15.json index 375e6c2c6f..0951777456 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2023-11-15.json @@ -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", @@ -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", @@ -90,6 +102,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", @@ -103,6 +121,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", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-05-30.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-05-30.json index a66cce5994..1f8a129793 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-05-30.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -121,6 +145,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -149,6 +179,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -167,6 +203,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", @@ -180,6 +222,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", @@ -255,6 +303,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -262,6 +316,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -273,6 +341,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -468,6 +542,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -486,6 +566,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-08-05.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-08-05.json index c29c96d3f2..5707e518cf 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-08-05.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -121,6 +145,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -149,6 +179,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -167,6 +203,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", @@ -180,6 +222,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", @@ -198,6 +246,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -364,6 +418,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -548,6 +608,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -571,6 +637,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -594,6 +666,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -668,6 +746,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -713,6 +861,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -726,6 +880,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -749,6 +909,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -756,6 +922,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -767,6 +947,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -988,6 +1174,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1006,6 +1198,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-10-23.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-10-23.json index c29c96d3f2..598878b418 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-10-23.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-10-23.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -121,6 +145,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -149,6 +179,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -167,6 +203,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", @@ -180,6 +222,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", @@ -198,6 +246,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -266,6 +320,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -364,6 +424,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -432,6 +498,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -548,6 +620,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -571,6 +649,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -594,6 +678,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -668,6 +758,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -713,6 +873,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -726,6 +892,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -749,6 +921,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -756,6 +934,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -767,6 +959,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -988,6 +1186,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1006,6 +1210,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-11-13.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-11-13.json index f6e56944ec..0d3ddd9485 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-11-13.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2024-11-13.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -121,6 +145,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -149,6 +179,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -180,6 +216,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", @@ -193,6 +235,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", @@ -211,6 +259,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -279,6 +333,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -377,6 +437,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -445,6 +511,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -561,6 +633,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -584,6 +662,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -607,6 +691,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -681,6 +771,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -726,6 +886,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -739,6 +905,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -762,6 +934,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -769,6 +947,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -780,6 +972,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -1157,6 +1355,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1175,6 +1379,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2025-02-19.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2025-02-19.json index f322f11a92..f4b36a0cde 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2025-02-19.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2025-02-19.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -121,6 +145,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -149,6 +179,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -180,6 +216,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", @@ -193,6 +235,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", @@ -211,6 +259,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -279,6 +333,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -377,6 +437,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -445,6 +511,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -561,6 +633,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -584,6 +662,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -607,6 +691,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -681,6 +771,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -726,6 +886,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -739,6 +905,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -762,6 +934,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -769,6 +947,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -780,6 +972,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -1157,6 +1355,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1175,6 +1379,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1497,6 +1707,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1559,6 +1775,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -1882,6 +2112,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1968,6 +2204,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -2030,6 +2272,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2025-03-12.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2025-03-12.json index 572d65910a..c889131ecd 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2025-03-12.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-02-01_2025-03-12.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -121,6 +145,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -149,6 +179,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -180,6 +216,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", @@ -193,6 +235,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", @@ -211,6 +259,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -279,6 +333,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -377,6 +437,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -445,6 +511,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -561,6 +633,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -584,6 +662,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -607,6 +691,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -681,6 +771,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -726,6 +886,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -739,6 +905,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -762,6 +934,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -769,6 +947,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2025-03-12 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -780,6 +986,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -1157,6 +1369,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1175,6 +1393,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1510,6 +1734,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1572,6 +1802,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -1895,6 +2139,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1981,6 +2231,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -2043,6 +2299,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2023-11-15.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2023-11-15.json index 5312656b63..9430ffbd02 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2023-11-15.json @@ -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", @@ -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", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-05-30.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-05-30.json index fa16671dba..2480cf6e74 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-05-30.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -121,6 +145,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -149,6 +179,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -224,6 +260,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -231,6 +273,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -242,6 +298,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -437,6 +499,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -455,6 +523,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-08-05.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-08-05.json index fc50f9c1e2..9678946e61 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-08-05.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -121,6 +145,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -149,6 +179,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -167,6 +203,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -333,6 +375,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -517,6 +565,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -540,6 +594,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -563,6 +623,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -637,6 +703,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -682,6 +818,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -695,6 +837,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -718,6 +866,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -725,6 +879,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -736,6 +904,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -957,6 +1131,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -975,6 +1155,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-10-23.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-10-23.json index fc50f9c1e2..245d98f434 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-10-23.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-10-23.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -121,6 +145,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -149,6 +179,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -167,6 +203,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -235,6 +277,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -333,6 +381,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -401,6 +455,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -517,6 +577,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -540,6 +606,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -563,6 +635,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -637,6 +715,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -682,6 +830,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -695,6 +849,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -718,6 +878,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -725,6 +891,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -736,6 +916,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -957,6 +1143,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -975,6 +1167,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-11-13.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-11-13.json index 4be5ccc6d0..7b8a0c2bcd 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-11-13.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2024-11-13.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -121,6 +145,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -149,6 +179,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -180,6 +216,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -248,6 +290,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -346,6 +394,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -414,6 +468,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -530,6 +590,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -553,6 +619,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -576,6 +648,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -650,6 +728,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -695,6 +843,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -708,6 +862,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -731,6 +891,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -738,6 +904,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -749,6 +929,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -1126,6 +1312,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1144,6 +1336,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2025-02-19.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2025-02-19.json index 59ebec42e4..e8041188ee 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2025-02-19.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2025-02-19.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -121,6 +145,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -149,6 +179,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -180,6 +216,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -248,6 +290,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -346,6 +394,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -414,6 +468,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -530,6 +590,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -553,6 +619,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -576,6 +648,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -650,6 +728,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -695,6 +843,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -708,6 +862,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -731,6 +891,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -738,6 +904,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -749,6 +929,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -1126,6 +1312,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1144,6 +1336,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1466,6 +1664,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1528,6 +1732,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -1851,6 +2069,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1937,6 +2161,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1999,6 +2229,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2025-03-12.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2025-03-12.json index 177976d1e1..a520ef7a03 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2025-03-12.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-10-01_2025-03-12.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -121,6 +145,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -149,6 +179,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -180,6 +216,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -248,6 +290,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -346,6 +394,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -414,6 +468,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -530,6 +590,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -553,6 +619,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -576,6 +648,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -650,6 +728,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -695,6 +843,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -708,6 +862,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -731,6 +891,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -738,6 +904,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2025-03-12 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -749,6 +943,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -1126,6 +1326,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1144,6 +1350,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1479,6 +1691,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1541,6 +1759,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -1864,6 +2096,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1950,6 +2188,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -2012,6 +2256,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-05-30.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-05-30.json index 2628581f89..b88316025f 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-05-30.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-05-30.json @@ -5,6 +5,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -18,6 +24,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -36,6 +48,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -64,6 +82,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -87,6 +111,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -94,6 +124,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -105,6 +149,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -261,6 +311,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -279,6 +335,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-08-05.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-08-05.json index d5a9a00ee6..c7ffccbcc7 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-08-05.json @@ -5,6 +5,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -18,6 +24,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -36,6 +48,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -64,6 +82,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -82,6 +106,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -248,6 +278,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -432,6 +468,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -455,6 +497,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -478,6 +526,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -500,6 +554,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -545,6 +669,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -558,6 +688,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -581,6 +717,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -588,6 +730,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -599,6 +755,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -781,6 +943,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -799,6 +967,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-10-23.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-10-23.json index d5a9a00ee6..14afabad9f 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-10-23.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-10-23.json @@ -5,6 +5,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -18,6 +24,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -36,6 +48,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -64,6 +82,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -82,6 +106,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -150,6 +180,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -248,6 +284,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -316,6 +358,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -432,6 +480,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -455,6 +509,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -478,6 +538,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -500,6 +566,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -545,6 +681,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -558,6 +700,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -581,6 +729,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -588,6 +742,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -599,6 +767,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -781,6 +955,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -799,6 +979,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-11-13.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-11-13.json index e56a8d4222..86ef102b97 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-11-13.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2024-11-13.json @@ -5,6 +5,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -18,6 +24,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -36,6 +48,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -64,6 +82,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -95,6 +119,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -163,6 +193,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -261,6 +297,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -329,6 +371,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -445,6 +493,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -468,6 +522,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -491,6 +551,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -513,6 +579,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -558,6 +694,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -571,6 +713,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -594,6 +742,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -601,6 +755,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -612,6 +780,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -950,6 +1124,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -968,6 +1148,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2025-02-19.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2025-02-19.json index e090256cc7..4dd26d000d 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2025-02-19.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2025-02-19.json @@ -5,6 +5,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -18,6 +24,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -36,6 +48,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -64,6 +82,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -95,6 +119,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -163,6 +193,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -261,6 +297,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -329,6 +371,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -445,6 +493,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -468,6 +522,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -491,6 +551,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -513,6 +579,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -558,6 +694,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -571,6 +713,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -594,6 +742,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -601,6 +755,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -612,6 +780,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -950,6 +1124,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -968,6 +1148,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1264,6 +1450,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1326,6 +1518,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -1649,6 +1855,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1735,6 +1947,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1797,6 +2015,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2025-03-12.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2025-03-12.json index f35fcedb0e..a554ce446d 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2025-03-12.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2023-11-15_2025-03-12.json @@ -5,6 +5,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -18,6 +24,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -36,6 +48,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -64,6 +82,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -95,6 +119,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -163,6 +193,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -261,6 +297,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -329,6 +371,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -445,6 +493,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -468,6 +522,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -491,6 +551,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -513,6 +579,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -558,6 +694,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -571,6 +713,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -594,6 +742,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -601,6 +755,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2025-03-12 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -612,6 +794,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -950,6 +1138,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -968,6 +1162,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -1277,6 +1477,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1339,6 +1545,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -1662,6 +1882,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1748,6 +1974,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1810,6 +2042,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2024-08-05.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2024-08-05.json index 4a066c8847..2cd7ad5b27 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2024-08-05.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2024-08-05.json @@ -5,6 +5,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -171,6 +177,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -355,6 +367,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -378,6 +396,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -401,6 +425,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -423,6 +453,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -468,6 +568,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -481,6 +587,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -675,6 +787,20 @@ } ] }, + { + "path": "/api/atlas/v2/openapi/info", + "httpMethod": "GET", + "operationId": "getOpenApiInfo", + "tag": "OpenAPI", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2024-05-30.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-05-30" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2024-10-23.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2024-10-23.json index 4a066c8847..e02fd339a2 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2024-10-23.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2024-10-23.json @@ -5,6 +5,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -73,6 +79,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -171,6 +183,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -239,6 +257,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -355,6 +379,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -378,6 +408,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -401,6 +437,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -423,6 +465,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -468,6 +580,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -481,6 +599,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -675,6 +799,20 @@ } ] }, + { + "path": "/api/atlas/v2/openapi/info", + "httpMethod": "GET", + "operationId": "getOpenApiInfo", + "tag": "OpenAPI", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2024-05-30.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-05-30" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2024-11-13.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2024-11-13.json index 92967548d3..859d977dfe 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2024-11-13.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2024-11-13.json @@ -18,6 +18,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -86,6 +92,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -184,6 +196,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -252,6 +270,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -368,6 +392,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -391,6 +421,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -414,6 +450,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -436,6 +478,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -481,6 +593,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -494,6 +612,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -870,6 +994,20 @@ } ] }, + { + "path": "/api/atlas/v2/openapi/info", + "httpMethod": "GET", + "operationId": "getOpenApiInfo", + "tag": "OpenAPI", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2024-05-30.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-05-30" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2025-02-19.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2025-02-19.json index 7c9ca1f46a..8ef3f11f43 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2025-02-19.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2025-02-19.json @@ -18,6 +18,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -86,6 +92,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -184,6 +196,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -252,6 +270,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -368,6 +392,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -391,6 +421,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -414,6 +450,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -436,6 +478,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -481,6 +593,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -494,6 +612,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -881,6 +1005,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -943,6 +1073,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -982,6 +1126,20 @@ } ] }, + { + "path": "/api/atlas/v2/openapi/info", + "httpMethod": "GET", + "operationId": "getOpenApiInfo", + "tag": "OpenAPI", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2024-05-30.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-05-30" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search", "httpMethod": "GET", @@ -1240,6 +1398,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1326,6 +1490,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1388,6 +1558,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2025-03-12.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2025-03-12.json index 7edc4312a1..ab0a5f710c 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2025-03-12.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2025-03-12.json @@ -18,6 +18,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -86,6 +92,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -184,6 +196,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -252,6 +270,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-10-23 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -368,6 +392,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -391,6 +421,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -414,6 +450,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -436,6 +478,76 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", "httpMethod": "GET", @@ -481,6 +593,12 @@ "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -494,6 +612,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -506,6 +630,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2025-03-12 was added. It replaces API version 2024-05-30.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-05-30" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess", "httpMethod": "POST", @@ -894,6 +1032,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -956,6 +1100,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -995,6 +1153,20 @@ } ] }, + { + "path": "/api/atlas/v2/openapi/info", + "httpMethod": "GET", + "operationId": "getOpenApiInfo", + "tag": "OpenAPI", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2024-05-30.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-05-30" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search", "httpMethod": "GET", @@ -1253,6 +1425,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1339,6 +1517,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -1401,6 +1585,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2025-09-22.upcoming.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2025-09-22.upcoming.json index 10d78e7e34..c9df3259de 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2025-09-22.upcoming.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-05-30_2025-09-22.upcoming.json @@ -5,6 +5,12 @@ "operationId": "getOpenApiInfo", "tag": "OpenAPI", "changes": [ + { + "change": "API version 2025-09-22.upcoming was added. It replaces API version 2024-05-30.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-05-30" + }, { "change": "media type `application/json` was changed to a more specific media type `application/vnd.atlas.2025-09-22.upcoming+json` for the response status `200`", "changeCode": "response-media-type-name-specialized", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2024-10-23.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2024-10-23.json index fe51488c70..a63dbe7f6a 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2024-10-23.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2024-10-23.json @@ -1 +1,30 @@ -[] +[ + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "operationId": "createCluster", + "tag": "Clusters", + "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2024-08-05.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-08-05" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "operationId": "updateCluster", + "tag": "Clusters", + "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2024-08-05.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-08-05" + } + ] + } +] diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2024-11-13.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2024-11-13.json index 2443725174..a68c89fa12 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2024-11-13.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2024-11-13.json @@ -12,6 +12,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "operationId": "createCluster", + "tag": "Clusters", + "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2024-08-05.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-08-05" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "operationId": "updateCluster", + "tag": "Clusters", + "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2024-08-05.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-08-05" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/flexClusters", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2025-02-19.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2025-02-19.json index 6432eb99d3..80d118c969 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2025-02-19.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2025-02-19.json @@ -12,6 +12,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "operationId": "createCluster", + "tag": "Clusters", + "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2024-08-05.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-08-05" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "operationId": "updateCluster", + "tag": "Clusters", + "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2024-08-05.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-08-05" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/flexClusters", "httpMethod": "GET", @@ -205,6 +233,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -267,6 +301,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -317,6 +365,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -403,6 +457,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -465,6 +525,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2025-03-12.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2025-03-12.json index f030f1ef9c..a0fc81f430 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2025-03-12.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-08-05_2025-03-12.json @@ -12,6 +12,48 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "operationId": "createCluster", + "tag": "Clusters", + "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2024-08-05.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-08-05" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "operationId": "updateCluster", + "tag": "Clusters", + "changes": [ + { + "change": "API version 2024-10-23 was added. It replaces API version 2024-08-05.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-08-05" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2025-03-12 was added. It replaces API version 2024-05-30.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-05-30" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/flexClusters", "httpMethod": "GET", @@ -218,6 +260,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -280,6 +328,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -330,6 +392,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -416,6 +484,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -478,6 +552,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-10-23_2025-02-19.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-10-23_2025-02-19.json index 6432eb99d3..a55b0f7167 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-10-23_2025-02-19.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-10-23_2025-02-19.json @@ -205,6 +205,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -267,6 +273,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -317,6 +337,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -403,6 +429,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -465,6 +497,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-10-23_2025-03-12.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-10-23_2025-03-12.json index f030f1ef9c..9b71ea39c7 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-10-23_2025-03-12.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-10-23_2025-03-12.json @@ -12,6 +12,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2025-03-12 was added. It replaces API version 2024-05-30.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-05-30" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/flexClusters", "httpMethod": "GET", @@ -218,6 +232,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -280,6 +300,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -330,6 +364,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -416,6 +456,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -478,6 +524,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-11-13_2025-02-19.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-11-13_2025-02-19.json index 809249fe5d..cb1c95a680 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-11-13_2025-02-19.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-11-13_2025-02-19.json @@ -10,6 +10,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -72,6 +78,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -122,6 +142,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -208,6 +234,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -270,6 +302,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-11-13_2025-03-12.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-11-13_2025-03-12.json index da2d6bd921..8e13ce4294 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2024-11-13_2025-03-12.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2024-11-13_2025-03-12.json @@ -1,4 +1,18 @@ [ + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2025-03-12 was added. It replaces API version 2024-05-30.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-05-30" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:startWith", "httpMethod": "POST", @@ -23,6 +37,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -85,6 +105,20 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeProjectUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 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}/users/{userId}", "httpMethod": "GET", @@ -135,6 +169,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -221,6 +261,12 @@ "changeCode": "response-property-type-changed", "backwardCompatible": false }, + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -283,6 +329,20 @@ } ] }, + { + "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", + "httpMethod": "DELETE", + "operationId": "removeOrganizationUser", + "tag": "MongoDB Cloud Users", + "changes": [ + { + "change": "API version 2025-02-19 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + } + ] + }, { "path": "/api/atlas/v2/orgs/{orgId}/users/{userId}", "httpMethod": "GET", diff --git a/tools/cli/test/data/changelog/new-upcoming-version/output/2025-02-19_2025-03-12.json b/tools/cli/test/data/changelog/new-upcoming-version/output/2025-02-19_2025-03-12.json index e9d777d7e6..72d14268f2 100644 --- a/tools/cli/test/data/changelog/new-upcoming-version/output/2025-02-19_2025-03-12.json +++ b/tools/cli/test/data/changelog/new-upcoming-version/output/2025-02-19_2025-03-12.json @@ -1,4 +1,18 @@ [ + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2025-03-12 was added. It replaces API version 2024-05-30.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2024-05-30" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:startWith", "httpMethod": "POST", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2023-02-01.json b/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2023-02-01.json index fe46362b81..739fa32e39 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2023-02-01.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2023-02-01.json @@ -115,6 +115,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", @@ -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", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2023-10-01.json b/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2023-10-01.json index 2dc8b57908..156d9dbc2c 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2023-10-01.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2023-10-01.json @@ -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", @@ -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", @@ -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", @@ -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", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2023-11-15.json b/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2023-11-15.json index 5d43f39b88..25bfa48548 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2023-11-15.json @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2024-05-30.json b/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2024-05-30.json index 60f30c2ce9..c9b16024c6 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2024-05-30.json @@ -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", @@ -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", @@ -103,6 +115,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -116,6 +134,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -139,6 +163,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -177,6 +207,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -200,6 +236,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", @@ -213,6 +255,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", @@ -328,6 +376,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", @@ -483,6 +545,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}/search/deployment", "httpMethod": "DELETE", @@ -494,6 +570,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -501,6 +583,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -512,6 +622,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -662,6 +778,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", @@ -681,6 +811,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -699,6 +835,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2024-08-05.json b/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2024-08-05.json index 7885cb561b..a17b234746 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2023-01-01_2024-08-05.json @@ -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", @@ -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", @@ -103,6 +115,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -116,6 +134,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -139,6 +163,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -177,6 +207,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -200,6 +236,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", @@ -213,6 +255,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", @@ -231,6 +279,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -260,6 +314,12 @@ "operationId": "createCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -308,12 +368,32 @@ } ] }, + { + "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", "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -343,6 +423,12 @@ "operationId": "updateCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -402,6 +488,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -425,6 +517,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -448,6 +546,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -522,12 +626,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -541,6 +721,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -553,6 +739,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}/search/deployment", "httpMethod": "DELETE", @@ -564,6 +764,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -571,6 +777,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -582,6 +816,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -732,6 +972,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", @@ -751,6 +1005,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -769,6 +1029,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2023-10-01.json b/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2023-10-01.json index d7d69d80df..f652926771 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2023-10-01.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2023-10-01.json @@ -5,6 +5,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", @@ -18,6 +24,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", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2023-11-15.json b/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2023-11-15.json index e6e4c9e081..3e837fcc24 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2023-11-15.json @@ -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", @@ -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", @@ -90,6 +102,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", @@ -103,6 +121,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", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2024-05-30.json b/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2024-05-30.json index 953f8e59de..02ad3bc994 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2024-05-30.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -187,6 +223,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", @@ -200,6 +242,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", @@ -275,6 +323,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -282,6 +336,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -293,6 +375,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -462,6 +550,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -480,6 +574,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2024-08-05.json b/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2024-08-05.json index 9898f971b4..f8851d7c7a 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2023-02-01_2024-08-05.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -187,6 +223,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", @@ -200,6 +242,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", @@ -218,6 +266,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -286,6 +340,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -384,6 +444,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -452,6 +518,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -555,6 +627,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -578,6 +656,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -601,6 +685,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -675,12 +765,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -694,6 +860,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -717,6 +889,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -724,6 +902,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -735,6 +941,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -904,6 +1116,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -922,6 +1140,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2023-10-01_2023-11-15.json b/tools/cli/test/data/changelog/rename-api-version/output/2023-10-01_2023-11-15.json index 0fc0cd1847..f9728bad5d 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2023-10-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2023-10-01_2023-11-15.json @@ -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", @@ -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", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2023-10-01_2024-05-30.json b/tools/cli/test/data/changelog/rename-api-version/output/2023-10-01_2024-05-30.json index f137518500..bcae4a4af3 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2023-10-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2023-10-01_2024-05-30.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -244,6 +280,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -251,6 +293,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -262,6 +332,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -431,6 +507,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -449,6 +531,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2023-10-01_2024-08-05.json b/tools/cli/test/data/changelog/rename-api-version/output/2023-10-01_2024-08-05.json index 5634178f5f..cd4162a67e 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2023-10-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2023-10-01_2024-08-05.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -187,6 +223,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -255,6 +297,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -353,6 +401,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -421,6 +475,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -524,6 +584,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -547,6 +613,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -570,6 +642,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -644,12 +722,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -663,6 +817,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -686,6 +846,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -693,6 +859,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -704,6 +898,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -873,6 +1073,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -891,6 +1097,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2023-11-15_2024-05-30.json b/tools/cli/test/data/changelog/rename-api-version/output/2023-11-15_2024-05-30.json index 520e4f3f0a..8129561f12 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2023-11-15_2024-05-30.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2023-11-15_2024-05-30.json @@ -5,6 +5,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -18,6 +24,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -41,6 +53,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -79,6 +97,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -107,6 +131,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -114,6 +144,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -125,6 +183,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -255,6 +319,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -273,6 +343,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2023-11-15_2024-08-05.json b/tools/cli/test/data/changelog/rename-api-version/output/2023-11-15_2024-08-05.json index 7597685871..097a36e4f0 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2023-11-15_2024-08-05.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2023-11-15_2024-08-05.json @@ -5,6 +5,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -18,6 +24,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -41,6 +53,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -79,6 +97,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -102,6 +126,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -170,6 +200,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -268,6 +304,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -336,6 +378,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -439,6 +487,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -462,6 +516,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -485,6 +545,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -507,12 +573,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -526,6 +668,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -549,6 +697,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -556,6 +710,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -567,6 +749,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -697,6 +885,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -715,6 +909,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/2024-05-30_2024-08-05.json b/tools/cli/test/data/changelog/rename-api-version/output/2024-05-30_2024-08-05.json index 2cb25811ad..5c337e1f4e 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/2024-05-30_2024-08-05.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/2024-05-30_2024-08-05.json @@ -5,6 +5,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -73,6 +79,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -171,6 +183,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -239,6 +257,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -342,6 +366,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -365,6 +395,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -388,6 +424,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -410,12 +452,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -429,6 +547,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", diff --git a/tools/cli/test/data/changelog/rename-api-version/output/changelog-all.json b/tools/cli/test/data/changelog/rename-api-version/output/changelog-all.json index 786fde0761..6b550f4276 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/changelog-all.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/changelog-all.json @@ -1,6 +1,6 @@ [ { - "date": "2026-04-15", + "date": "2026-07-09", "paths": [ { "path": "/api/atlas/v2/groups/{groupId}/clusters", @@ -9,6 +9,12 @@ { "version": "2024-08-05", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -62,6 +68,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "listClusters", @@ -84,6 +105,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -177,6 +204,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "createCluster", @@ -189,6 +231,12 @@ { "version": "2024-08-05", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -242,6 +290,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "getCluster", @@ -264,6 +327,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -357,6 +426,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "updateCluster", @@ -374,6 +458,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -387,6 +477,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "deleteAllBackupSchedules", @@ -404,6 +509,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -417,6 +528,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "getBackupSchedule", @@ -434,6 +560,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -457,140 +589,292 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "updateBackupSchedule", "tag": "Cloud Backups" }, { - "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", "httpMethod": "GET", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "getClusterAdvancedConfiguration", - "tag": "Clusters" + "operationId": "getManagedNamespace", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", - "httpMethod": "PATCH", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false - }, - { - "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", - "changeCode": "request-property-removed", - "backwardCompatible": false + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "updateClusterAdvancedConfiguration", - "tag": "Clusters" + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", "httpMethod": "POST", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `pipeline` request property `type` changed from `string` to `array`", - "changeCode": "request-property-type-changed", - "backwardCompatible": false - }, - { - "change": "the `pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", - "backwardCompatible": false - }, + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ], + "stabilityLevel": "stable", + "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ { - "change": "added the optional property 'options' to the response with the '200' status", - "changeCode": "response-optional-property-added", - "backwardCompatible": true - }, + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" + } + ], + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "versions": [ + { + "version": "2024-08-05", + "changes": [ { - "change": "removed the optional property 'dlq' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false - }, + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ], + "stabilityLevel": "stable", + "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ { - "change": "removed the request property 'dlq'", - "changeCode": "request-property-removed", - "backwardCompatible": false - }, + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" + } + ], + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-08-05", + "changes": [ { - "change": "added the new optional request property 'options'", - "changeCode": "new-optional-request-property", - "backwardCompatible": true + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "createStreamProcessor", - "tag": "Streams" + "operationId": "createManagedNamespace", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", + "changeCode": "response-optional-property-removed", "backwardCompatible": false } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "getStreamProcessor", - "tag": "Streams" + "operationId": "getClusterAdvancedConfiguration", + "tag": "Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", - "httpMethod": "GET", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "PATCH", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `results/items/pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", + "changeCode": "response-optional-property-removed", + "backwardCompatible": false + }, + { + "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", + "changeCode": "request-property-removed", "backwardCompatible": false } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "listStreamProcessors", - "tag": "Streams" + "operationId": "updateClusterAdvancedConfiguration", + "tag": "Clusters" } ] }, diff --git a/tools/cli/test/data/changelog/rename-api-version/output/changelog.json b/tools/cli/test/data/changelog/rename-api-version/output/changelog.json index 786fde0761..6b550f4276 100644 --- a/tools/cli/test/data/changelog/rename-api-version/output/changelog.json +++ b/tools/cli/test/data/changelog/rename-api-version/output/changelog.json @@ -1,6 +1,6 @@ [ { - "date": "2026-04-15", + "date": "2026-07-09", "paths": [ { "path": "/api/atlas/v2/groups/{groupId}/clusters", @@ -9,6 +9,12 @@ { "version": "2024-08-05", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -62,6 +68,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "listClusters", @@ -84,6 +105,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -177,6 +204,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "createCluster", @@ -189,6 +231,12 @@ { "version": "2024-08-05", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -242,6 +290,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "getCluster", @@ -264,6 +327,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -357,6 +426,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "updateCluster", @@ -374,6 +458,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -387,6 +477,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "deleteAllBackupSchedules", @@ -404,6 +509,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -417,6 +528,21 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "getBackupSchedule", @@ -434,6 +560,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -457,140 +589,292 @@ ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], "operationId": "updateBackupSchedule", "tag": "Cloud Backups" }, { - "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", "httpMethod": "GET", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "getClusterAdvancedConfiguration", - "tag": "Clusters" + "operationId": "getManagedNamespace", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", - "httpMethod": "PATCH", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false - }, - { - "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", - "changeCode": "request-property-removed", - "backwardCompatible": false + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "updateClusterAdvancedConfiguration", - "tag": "Clusters" + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", "httpMethod": "POST", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `pipeline` request property `type` changed from `string` to `array`", - "changeCode": "request-property-type-changed", - "backwardCompatible": false - }, - { - "change": "the `pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", - "backwardCompatible": false - }, + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ], + "stabilityLevel": "stable", + "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ { - "change": "added the optional property 'options' to the response with the '200' status", - "changeCode": "response-optional-property-added", - "backwardCompatible": true - }, + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" + } + ], + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "versions": [ + { + "version": "2024-08-05", + "changes": [ { - "change": "removed the optional property 'dlq' from the response with the '200' status", - "changeCode": "response-optional-property-removed", - "backwardCompatible": false - }, + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ], + "stabilityLevel": "stable", + "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ { - "change": "removed the request property 'dlq'", - "changeCode": "request-property-removed", - "backwardCompatible": false - }, + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" + } + ], + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-08-05", + "changes": [ { - "change": "added the new optional request property 'options'", - "changeCode": "new-optional-request-property", - "backwardCompatible": true + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-02-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-02-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "createStreamProcessor", - "tag": "Streams" + "operationId": "createManagedNamespace", + "tag": "Global Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", + "changeCode": "response-optional-property-removed", "backwardCompatible": false } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "getStreamProcessor", - "tag": "Streams" + "operationId": "getClusterAdvancedConfiguration", + "tag": "Clusters" }, { - "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", - "httpMethod": "GET", + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "PATCH", "versions": [ { "version": "2024-08-05", "changes": [ { - "change": "the `results/items/pipeline` response's property `type` changed from `string` to `array` for status `200`", - "changeCode": "response-property-type-changed", + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", + "changeCode": "response-optional-property-removed", + "backwardCompatible": false + }, + { + "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", + "changeCode": "request-property-removed", "backwardCompatible": false } ], "stabilityLevel": "stable", "changeType": "release" + }, + { + "version": "2024-05-30", + "changes": [ + { + "change": "API version 2023-01-01 is deprecated and sunsets on 2099-01-01. Use API version 2024-08-05 instead.", + "changeCode": "endpoint-deprecated", + "backwardCompatible": true, + "deprecatedVersion": "2023-01-01", + "sunsetDate": "2099-01-01", + "replacedByVersion": "2024-08-05" + } + ], + "stabilityLevel": "stable", + "changeType": "deprecate" } ], - "operationId": "listStreamProcessors", - "tag": "Streams" + "operationId": "updateClusterAdvancedConfiguration", + "tag": "Clusters" } ] }, diff --git a/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2023-02-01.json b/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2023-02-01.json index fe46362b81..739fa32e39 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2023-02-01.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2023-02-01.json @@ -115,6 +115,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", @@ -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", diff --git a/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2023-10-01.json b/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2023-10-01.json index 2dc8b57908..156d9dbc2c 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2023-10-01.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2023-10-01.json @@ -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", @@ -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", @@ -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", @@ -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", diff --git a/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2023-11-15.json b/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2023-11-15.json index 5d43f39b88..25bfa48548 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2023-11-15.json @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", diff --git a/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2024-05-30.json b/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2024-05-30.json index 60f30c2ce9..c9b16024c6 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2024-05-30.json @@ -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", @@ -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", @@ -103,6 +115,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -116,6 +134,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -139,6 +163,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -177,6 +207,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -200,6 +236,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", @@ -213,6 +255,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", @@ -328,6 +376,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", @@ -483,6 +545,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}/search/deployment", "httpMethod": "DELETE", @@ -494,6 +570,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -501,6 +583,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -512,6 +622,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -662,6 +778,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", @@ -681,6 +811,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -699,6 +835,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2024-08-05.json b/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2024-08-05.json index 7885cb561b..a17b234746 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2023-01-01_2024-08-05.json @@ -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", @@ -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", @@ -103,6 +115,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -116,6 +134,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -139,6 +163,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -177,6 +207,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -200,6 +236,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", @@ -213,6 +255,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", @@ -231,6 +279,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -260,6 +314,12 @@ "operationId": "createCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -308,12 +368,32 @@ } ] }, + { + "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", "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the `backupEnabled` response's property default value `false` was added for the status `200`", "changeCode": "response-property-default-value-added", @@ -343,6 +423,12 @@ "operationId": "updateCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "the request optional property `mongoDBVersion` became read-only", "changeCode": "request-optional-property-became-read-only", @@ -402,6 +488,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -425,6 +517,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -448,6 +546,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -522,12 +626,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 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}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -541,6 +721,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -553,6 +739,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}/search/deployment", "httpMethod": "DELETE", @@ -564,6 +764,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -571,6 +777,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -582,6 +816,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -732,6 +972,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", @@ -751,6 +1005,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -769,6 +1029,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2023-10-01.json b/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2023-10-01.json index d7d69d80df..f652926771 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2023-10-01.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2023-10-01.json @@ -5,6 +5,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", @@ -18,6 +24,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", diff --git a/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2023-11-15.json b/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2023-11-15.json index e6e4c9e081..3e837fcc24 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2023-11-15.json @@ -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", @@ -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", @@ -90,6 +102,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", @@ -103,6 +121,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", diff --git a/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2024-05-30.json b/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2024-05-30.json index 953f8e59de..02ad3bc994 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2024-05-30.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -187,6 +223,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", @@ -200,6 +242,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", @@ -275,6 +323,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -282,6 +336,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -293,6 +375,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -462,6 +550,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -480,6 +574,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2024-08-05.json b/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2024-08-05.json index 9898f971b4..f8851d7c7a 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2023-02-01_2024-08-05.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -187,6 +223,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", @@ -200,6 +242,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", @@ -218,6 +266,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -286,6 +340,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -384,6 +444,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -452,6 +518,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -555,6 +627,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -578,6 +656,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -601,6 +685,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -675,12 +765,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -694,6 +860,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -717,6 +889,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -724,6 +902,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -735,6 +941,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -904,6 +1116,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -922,6 +1140,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/same-api-version/output/2023-10-01_2023-11-15.json b/tools/cli/test/data/changelog/same-api-version/output/2023-10-01_2023-11-15.json index 0fc0cd1847..f9728bad5d 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2023-10-01_2023-11-15.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2023-10-01_2023-11-15.json @@ -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", @@ -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", diff --git a/tools/cli/test/data/changelog/same-api-version/output/2023-10-01_2024-05-30.json b/tools/cli/test/data/changelog/same-api-version/output/2023-10-01_2024-05-30.json index f137518500..bcae4a4af3 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2023-10-01_2024-05-30.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2023-10-01_2024-05-30.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -244,6 +280,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -251,6 +293,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -262,6 +332,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -431,6 +507,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -449,6 +531,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/same-api-version/output/2023-10-01_2024-08-05.json b/tools/cli/test/data/changelog/same-api-version/output/2023-10-01_2024-08-05.json index 5634178f5f..cd4162a67e 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2023-10-01_2024-08-05.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2023-10-01_2024-08-05.json @@ -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", @@ -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", @@ -90,6 +102,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -103,6 +121,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -126,6 +150,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -164,6 +194,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -187,6 +223,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -255,6 +297,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -353,6 +401,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -421,6 +475,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -524,6 +584,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -547,6 +613,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -570,6 +642,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -644,12 +722,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -663,6 +817,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -686,6 +846,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -693,6 +859,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -704,6 +898,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -873,6 +1073,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -891,6 +1097,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/same-api-version/output/2023-11-15_2024-05-30.json b/tools/cli/test/data/changelog/same-api-version/output/2023-11-15_2024-05-30.json index 520e4f3f0a..8129561f12 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2023-11-15_2024-05-30.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2023-11-15_2024-05-30.json @@ -5,6 +5,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -18,6 +24,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -41,6 +53,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -79,6 +97,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -107,6 +131,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -114,6 +144,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -125,6 +183,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -255,6 +319,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -273,6 +343,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/same-api-version/output/2023-11-15_2024-08-05.json b/tools/cli/test/data/changelog/same-api-version/output/2023-11-15_2024-08-05.json index 7597685871..097a36e4f0 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2023-11-15_2024-08-05.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2023-11-15_2024-08-05.json @@ -5,6 +5,12 @@ "operationId": "acknowledgeAlert", "tag": "Alerts", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the new optional request property 'unacknowledgeAlert'", "changeCode": "new-optional-request-property", @@ -18,6 +24,12 @@ "operationId": "listExportBuckets", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added discriminator to `results/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-added", @@ -41,6 +53,12 @@ "operationId": "createExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added request discriminator", "changeCode": "request-body-discriminator-added", @@ -79,6 +97,12 @@ "operationId": "getExportBucket", "tag": "Cloud Backups", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added response discriminator for the response status `200`", "changeCode": "response-body-discriminator-added", @@ -102,6 +126,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -170,6 +200,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -268,6 +304,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -336,6 +378,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -439,6 +487,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -462,6 +516,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -485,6 +545,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -507,12 +573,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -526,6 +668,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -549,6 +697,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `204`", "changeCode": "response-success-status-added", @@ -556,6 +710,34 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "GET", + "operationId": "getAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "API version 2024-05-30 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}/search/deployment", "httpMethod": "POST", @@ -567,6 +749,12 @@ "changeCode": "response-success-status-removed", "backwardCompatible": false }, + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the success response with the status `201`", "changeCode": "response-success-status-added", @@ -697,6 +885,12 @@ "operationId": "createPushMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", @@ -715,6 +909,12 @@ "operationId": "validateMigration", "tag": "Cloud Migration Service", "changes": [ + { + "change": "API version 2024-05-30 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the request property 'dropEnabled'", "changeCode": "request-property-removed", diff --git a/tools/cli/test/data/changelog/same-api-version/output/2024-05-30_2024-08-05.json b/tools/cli/test/data/changelog/same-api-version/output/2024-05-30_2024-08-05.json index 2cb25811ad..5c337e1f4e 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/2024-05-30_2024-08-05.json +++ b/tools/cli/test/data/changelog/same-api-version/output/2024-05-30_2024-08-05.json @@ -5,6 +5,12 @@ "operationId": "listClusters", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `results/items/replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -73,6 +79,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -171,6 +183,12 @@ "operationId": "getCluster", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` response property for the response status `200`", "changeCode": "response-property-discriminator-mapping-changed", @@ -239,6 +257,12 @@ "changeCode": "request-property-one-of-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + }, { "change": "mapped value for discriminator key `AWS` changed from `#/components/schemas/AWSRegionConfig` to `#/components/schemas/AWSRegionConfig20240805` for `replicationSpecs/items/regionConfigs/items/` request property", "changeCode": "request-property-discriminator-mapping-changed", @@ -342,6 +366,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -365,6 +395,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -388,6 +424,12 @@ "changeCode": "response-optional-write-only-property-removed", "backwardCompatible": false }, + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "added the required property 'copySettings/items/zoneId' to the response with the '200' status", "changeCode": "response-required-property-added", @@ -410,12 +452,88 @@ } ] }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites", + "httpMethod": "GET", + "operationId": "getManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "DELETE", + "operationId": "deleteAllCustomZoneMappings", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping", + "httpMethod": "POST", + "operationId": "createCustomZoneMapping", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "DELETE", + "operationId": "deleteManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "operationId": "createManagedNamespace", + "tag": "Global Clusters", + "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-02-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-02-01" + } + ] + }, { "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", "httpMethod": "GET", "operationId": "getClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", @@ -429,6 +547,12 @@ "operationId": "updateClusterAdvancedConfiguration", "tag": "Clusters", "changes": [ + { + "change": "API version 2024-08-05 was added. It replaces API version 2023-01-01.", + "changeCode": "endpoint-version-added", + "backwardCompatible": true, + "replacesVersion": "2023-01-01" + }, { "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response with the '200' status", "changeCode": "response-optional-property-removed", diff --git a/tools/cli/test/data/changelog/same-api-version/output/changelog-all.json b/tools/cli/test/data/changelog/same-api-version/output/changelog-all.json index 9ee639fc34..d8d7027e9a 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/changelog-all.json +++ b/tools/cli/test/data/changelog/same-api-version/output/changelog-all.json @@ -1,6 +1,6 @@ [ { - "date": "2026-04-15", + "date": "2026-07-09", "paths": [ { "path": "/api/atlas/v2/groups/{groupId}/clusters", diff --git a/tools/cli/test/data/changelog/same-api-version/output/changelog.json b/tools/cli/test/data/changelog/same-api-version/output/changelog.json index 9ee639fc34..d8d7027e9a 100644 --- a/tools/cli/test/data/changelog/same-api-version/output/changelog.json +++ b/tools/cli/test/data/changelog/same-api-version/output/changelog.json @@ -1,6 +1,6 @@ [ { - "date": "2026-04-15", + "date": "2026-07-09", "paths": [ { "path": "/api/atlas/v2/groups/{groupId}/clusters", diff --git a/tools/cli/test/e2e/cli/changelog_test.go b/tools/cli/test/e2e/cli/changelog_test.go index 921216b91e..a0bec4c288 100644 --- a/tools/cli/test/e2e/cli/changelog_test.go +++ b/tools/cli/test/e2e/cli/changelog_test.go @@ -244,3 +244,66 @@ func newPathsFromPath(t *testing.T, path string) []*changelog.Path { require.NoError(t, json.Unmarshal(contents, &paths)) return paths } + +// TestChangelogVersionReleaseSurfacesDeprecation exercises the changelog pipeline +// (changelog.NewEntriesWithRunDate) directly — no CLI binary — to guard that a new +// API version release is recorded in changelog.json as a `release` on the new version +// plus a `deprecate` on the superseded one, independently of the golden fixtures. +func TestChangelogVersionReleaseSurfacesDeprecation(t *testing.T) { + entries, err := changelog.NewEntriesWithRunDate( + NewChangelogBasePathNewAPIVersion(t), + NewChangelogRevisionPathNewAPIVersion(t), + NewChangelogExepmtionFilePathNewAPIVersion(t), + "2026-07-09", // date on which 2024-08-05 is the active version + ) + require.NoError(t, err) + require.NotEmpty(t, entries) + + // entries are sorted by date DESC, so the run-date entry is first. + runEntry := entries[0] + path := findChangelogPath(t, runEntry, "GET", "/api/atlas/v2/groups/{groupId}/clusters") + + newVersion := findChangelogVersion(t, path, "2024-08-05") + assert.Equal(t, "release", newVersion.ChangeType, "new version should be a release") + versionAdded := findChange(t, newVersion, "endpoint-version-added") + assert.Equal(t, "2023-02-01", versionAdded.ReplacesVersion) + + oldVersion := findChangelogVersion(t, path, "2024-05-30") + assert.Equal(t, "deprecate", oldVersion.ChangeType, "superseded version should be deprecated") + deprecated := findChange(t, oldVersion, "endpoint-deprecated") + assert.NotEmpty(t, deprecated.SunsetDate, "deprecation should carry the resource's own sunset date") + assert.Equal(t, "2024-08-05", deprecated.ReplacedByVersion) +} + +func findChangelogPath(t *testing.T, entry *changelog.Entry, method, uri string) *changelog.Path { + t.Helper() + for _, p := range entry.Paths { + if p.HTTPMethod == method && p.URI == uri { + return p + } + } + t.Fatalf("path %s %s not found in changelog entry for %s", method, uri, entry.Date) + return nil +} + +func findChangelogVersion(t *testing.T, path *changelog.Path, version string) *changelog.Version { + t.Helper() + for _, v := range path.Versions { + if v.Version == version { + return v + } + } + t.Fatalf("version %s not found for %s %s", version, path.HTTPMethod, path.URI) + return nil +} + +func findChange(t *testing.T, version *changelog.Version, code string) *changelog.Change { + t.Helper() + for _, c := range version.Changes { + if c.Code == code { + return c + } + } + t.Fatalf("change code %s not found in version %s", code, version.Version) + return nil +} diff --git a/tools/foas/changelog/changelog.go b/tools/foas/changelog/changelog.go index fac0ebb6fe..7fab6e6b8b 100644 --- a/tools/foas/changelog/changelog.go +++ b/tools/foas/changelog/changelog.go @@ -102,6 +102,10 @@ type Change struct { Code string `json:"changeCode"` BackwardCompatible bool `json:"backwardCompatible"` HideFromChangelog bool `json:"hideFromChangelog,omitempty"` + DeprecatedVersion string `json:"deprecatedVersion,omitempty"` + SunsetDate string `json:"sunsetDate,omitempty"` + ReplacedByVersion string `json:"replacedByVersion,omitempty"` + ReplacesVersion string `json:"replacesVersion,omitempty"` } // NewEntries generates the changelog entries between the base and revision specs. @@ -160,6 +164,10 @@ func NewEntriesWithRunDate(basePath, revisionPath, exceptionFilePath, runDate st if err != nil { return nil, err } + // Original base changelog (previous run), before this run's changes are merged in. Used to + // re-seed the version-transition comparison below so it replaces, rather than stacks on, the + // same-version comparison. + seedChangelog := changelog.BaseChangelog changelogEntries, err := changelog.newEntryFromOasDiff() if err != nil { @@ -168,13 +176,20 @@ func NewEntriesWithRunDate(basePath, revisionPath, exceptionFilePath, runDate st changelog.BaseChangelog = changelogEntries if revisionActiveVersionOnRunDate != baseActiveVersionOnPreviousRunDate { - // new version was released or become active since last changelog run - // compare "baseActiveVersionOnPreviousRunDate" with "revisionActiveVersionOnRunDate" - // (using latest specs, since above, we're comparing - // baseActiveVersionOnPreviousRunDate with revisionActiveVersionOnPreviousRunDate) + // A new version was released (or became active) since the last changelog run, so recompute the + // run-date entry as the transition from the superseded version to the newly-active version. This + // is what lets the changelog record the release of the new version and the deprecation of the + // prior one (see the lifecycle handling in merge.go). + // + // The superseded version is loaded from the revision spec set (revisionMetadata.Path): the + // revision marks it deprecated with a sunset (because the newer version now exists), and that + // deprecated -> active transition is what the normalized diff surfaces as the version release. + // We seed from the original base changelog (not changelogEntries) so this comparison replaces the + // same-version comparison above instead of duplicating its schema changes. baseMetadata.ActiveVersion = baseActiveVersionOnRunDate revisionMetadata.ActiveVersion = revisionActiveVersionOnRunDate - changelog, err = newChangelog(baseMetadata, revisionMetadata, exceptionFilePath, changelogEntries) + baseMetadata.Path = revisionMetadata.Path + changelog, err = newChangelog(baseMetadata, revisionMetadata, exceptionFilePath, seedChangelog) if err != nil { return nil, err } @@ -183,6 +198,7 @@ func NewEntriesWithRunDate(basePath, revisionPath, exceptionFilePath, runDate st if err != nil { return nil, err } + changelog.BaseChangelog = changelogEntries } for _, version := range changelog.RevisionMetadata.Versions { diff --git a/tools/foas/changelog/merge.go b/tools/foas/changelog/merge.go index 5513f57d04..1b4c58604d 100644 --- a/tools/foas/changelog/merge.go +++ b/tools/foas/changelog/merge.go @@ -25,14 +25,16 @@ import ( ) const ( - endpointAddedCode = "endpoint-added" - endpointDeprecatedCode = "endpoint-deprecated" - endpointReactivatedCode = "endpoint-reactivated" - notSetPriority = 10 - changeTypeRelease = "release" - changeTypeUpdate = "update" - changeTypeDeprecated = "deprecate" - changeTypeRemove = "remove" + endpointAddedCode = "endpoint-added" + endpointDeprecatedCode = "endpoint-deprecated" + endpointReactivatedCode = "endpoint-reactivated" + endpointRemovedCode = "endpoint-removed" + endpointVersionAddedCode = "endpoint-version-added" + notSetPriority = 10 + changeTypeRelease = "release" + changeTypeUpdate = "update" + changeTypeDeprecated = "deprecate" + changeTypeRemove = "remove" ) func newChangeTypePriority() map[string]int { @@ -46,7 +48,10 @@ func newChangeTypePriority() map[string]int { func newChangeTypeOverrides() map[string]string { return map[string]string{ - endpointAddedCode: changeTypeRelease, + endpointAddedCode: changeTypeRelease, + endpointVersionAddedCode: changeTypeRelease, + endpointDeprecatedCode: changeTypeDeprecated, + endpointRemovedCode: changeTypeRemove, } } @@ -131,12 +136,7 @@ func (m *Changelog) newEntryFromOasDiff() ([]*Entry, error) { conf := outputfilter.NewOperationConfigs(m.Base, m.Revision) - changeType := changeTypeUpdate - if m.BaseMetadata.ActiveVersion != m.RevisionMetadata.ActiveVersion { - changeType = changeTypeRelease - } - - return m.mergeChangelog(changeType, changes, conf) + return m.mergeChangelog(changeTypeUpdate, changes, conf) } // mergeChangelog merges the base changelog with the new changes @@ -190,7 +190,7 @@ func (m *Changelog) newPathsFromRevisionChanges( changes []*outputfilter.OasDiffEntry, changeType string, changelogPath *[]*Path, conf map[string]*outputfilter.OperationConfigs) ([]*Path, error) { - revisionChanges := m.newRevisionChanges(changes) + revisionChanges := newRevisionChanges(changes, conf) return newMergedChanges(revisionChanges, changeType, m.RevisionMetadata.ActiveVersion, changelogPath, conf) } @@ -199,7 +199,7 @@ func (m *Changelog) newPathsFromDeprecatedChanges( changes []*outputfilter.OasDiffEntry, changelogPath *[]*Path, conf map[string]*outputfilter.OperationConfigs) ([]*Path, error) { - deprecatedChanges := m.newDeprecatedByNewerVersionOasDiffEntries(changes, conf) + deprecatedChanges := newDeprecatedByNewerVersionOasDiffEntries(changes, conf) return newMergedChanges(deprecatedChanges, changeTypeDeprecated, m.BaseMetadata.ActiveVersion, changelogPath, conf) } @@ -270,6 +270,10 @@ func newMergedChanges(changes []*outputfilter.OasDiffEntry, Code: change.ID, BackwardCompatible: change.LevelWithDefault() < int(checker.ERR), HideFromChangelog: change.HideFromChangelog, + DeprecatedVersion: change.DeprecatedVersion, + SunsetDate: change.SunsetDate, + ReplacedByVersion: change.ReplacedByVersion, + ReplacesVersion: change.ReplacesVersion, } pathEntryVersion.Changes = append(pathEntryVersion.Changes, versionChange) @@ -285,30 +289,34 @@ var priorityGivenChangeType = func(changeType string) int { return notSetPriority } -func (m *Changelog) newDeprecatedByNewerVersionOasDiffEntries( +func newDeprecatedByNewerVersionOasDiffEntries( changes []*outputfilter.OasDiffEntry, operationConfig map[string]*outputfilter.OperationConfigs) []*outputfilter.OasDiffEntry { - // deprecation by newer version occurs only when - // base_version is different than revision_version - if m.BaseMetadata.ActiveVersion == m.RevisionMetadata.ActiveVersion { - return nil - } - - // when comparing specs from 2 versions, we first normalize the specs - // (replacing versioned media-types with standard media-types). - // Base version endpoint is marked as deprecated and with a sunset date, - // while the revision endpoint is active. - // This will result in changes where the endpoint appears as reactivated - // (transition from deprecated with sunset to active). - // For changelog we want to transform these reactivation changes - // to the real change: "endpoint-deprecated". newChanges := make([]*outputfilter.OasDiffEntry, 0) + // Deduplicate by OperationID: a single operation can surface several reactivation signals + // (one per media type), but the version transition is one event, so emit at most one + // deprecation entry per operation. + added := make(map[string]struct{}) for _, change := range changes { + // Normalized versioned specs surface "old version deprecated, new version active" as reactivation. if change.ID != endpointReactivatedCode { continue } + baseVersion, revisionVersion, ok := endpointVersionLifecycle(change, operationConfig) + if !ok { + continue + } + if _, ok := added[change.OperationID]; ok { + continue + } - newChanges = append(newChanges, newDeprecatedChangeEntry(change, m.BaseMetadata.ActiveVersion, m.RevisionMetadata.ActiveVersion, operationConfig)) + conf := operationConfig[change.OperationID] + if conf.Base.Sunset == "" { + continue + } + + newChanges = append(newChanges, newDeprecatedChangeEntry(change, baseVersion, revisionVersion, conf.Base.Sunset)) + added[change.OperationID] = struct{}{} } return newChanges @@ -317,31 +325,57 @@ func (m *Changelog) newDeprecatedByNewerVersionOasDiffEntries( func newDeprecatedChangeEntry( change *outputfilter.OasDiffEntry, baseVersion, revisionVersion string, - operationConfig map[string]*outputfilter.OperationConfigs) *outputfilter.OasDiffEntry { - conf := operationConfig[change.OperationID] - baseVersionSunset := func() string { - if conf != nil { - return conf.Sunset() - } - return "" - }() - + baseVersionSunset string) *outputfilter.OasDiffEntry { return &outputfilter.OasDiffEntry{ ID: endpointDeprecatedCode, Operation: change.Operation, OperationID: change.OperationID, Text: fmt.Sprintf( - "New resource added %s. Resource version %s deprecated and marked for removal on %s", - revisionVersion, baseVersion, baseVersionSunset), + "API version %s is deprecated and sunsets on %s. Use API version %s instead.", + baseVersion, baseVersionSunset, revisionVersion), + Level: change.Level, + Path: change.Path, + HideFromChangelog: change.HideFromChangelog, + Date: change.Date, + Source: change.Source, + Section: change.Section, + DeprecatedVersion: baseVersion, + SunsetDate: baseVersionSunset, + ReplacedByVersion: revisionVersion, + } +} + +func newEndpointVersionAddedChangeEntry(change *outputfilter.OasDiffEntry, baseVersion, revisionVersion string) *outputfilter.OasDiffEntry { + return &outputfilter.OasDiffEntry{ + ID: endpointVersionAddedCode, + Operation: change.Operation, + OperationID: change.OperationID, + Text: fmt.Sprintf( + "API version %s was added. It replaces API version %s.", + revisionVersion, baseVersion), Level: change.Level, Path: change.Path, HideFromChangelog: change.HideFromChangelog, Date: change.Date, Source: change.Source, Section: change.Section, + ReplacesVersion: baseVersion, } } +func endpointVersionLifecycle( + change *outputfilter.OasDiffEntry, + operationConfig map[string]*outputfilter.OperationConfigs) (baseVersion, revisionVersion string, ok bool) { + conf := operationConfig[change.OperationID] + if conf == nil || conf.Base == nil || conf.Revision == nil { + return "", "", false + } + + baseVersion = conf.Base.Version + revisionVersion = conf.Revision.Version + return baseVersion, revisionVersion, baseVersion != "" && revisionVersion != "" && baseVersion != revisionVersion +} + func newChangeType(currentChangeType, newChangeType, changeCode string) string { changeType, ok := newChangeTypeOverrides()[changeCode] if !ok { @@ -363,9 +397,10 @@ func newEntryVersion(versions *[]*Version, specVersion string) *Version { } } - newVersion := []*Version{{ + newVersion := make([]*Version, 1, len(*versions)+1) + newVersion[0] = &Version{ Version: specVersion, - }} + } *versions = append(newVersion, *versions...) return (*versions)[0] } @@ -379,25 +414,39 @@ func newPathEntry(paths *[]*Path, path, operation string) *Path { } } - newPath := []*Path{{ + newPath := make([]*Path, 1, len(*paths)+1) + newPath[0] = &Path{ URI: path, HTTPMethod: operation, Versions: make([]*Version, 0), - }} + } *paths = append(newPath, *paths...) return (*paths)[0] } -func (m *Changelog) newRevisionChanges(changes []*outputfilter.OasDiffEntry) []*outputfilter.OasDiffEntry { - if m.BaseMetadata.ActiveVersion == m.RevisionMetadata.ActiveVersion { - return changes - } - +func newRevisionChanges( + changes []*outputfilter.OasDiffEntry, + operationConfig map[string]*outputfilter.OperationConfigs) []*outputfilter.OasDiffEntry { out := make([]*outputfilter.OasDiffEntry, 0) + // Deduplicate by OperationID: an operation can surface several reactivation signals (one per + // media type), but endpoint-version-added is one event per operation. + added := make(map[string]struct{}) for _, change := range changes { - if change.ID != endpointReactivatedCode { - out = append(out, change) + if change.ID == endpointReactivatedCode { + baseVersion, revisionVersion, hasLifecycle := endpointVersionLifecycle(change, operationConfig) + if !hasLifecycle { + out = append(out, change) + continue + } + + if _, ok := added[change.OperationID]; !ok { + out = append(out, newEndpointVersionAddedChangeEntry(change, baseVersion, revisionVersion)) + added[change.OperationID] = struct{}{} + } + continue } + + out = append(out, change) } return out diff --git a/tools/foas/changelog/merge_test.go b/tools/foas/changelog/merge_test.go index 9aefc75cd4..7b2ba2e132 100644 --- a/tools/foas/changelog/merge_test.go +++ b/tools/foas/changelog/merge_test.go @@ -165,7 +165,7 @@ func TestMergeChangelogTwoVersionsNoDeprecations(t *testing.T) { require.NoError(t, err) secondVersion := "2023-02-02" - changeTypeSecondVersion := changeTypeRelease + changeTypeSecondVersion := changeTypeUpdate changelogStruct = &Changelog{ BaseMetadata: &Metadata{ @@ -201,7 +201,7 @@ func TestMergeChangelogTwoVersionsNoDeprecations(t *testing.T) { firstVersionEntry := versions[0] require.Len(t, firstVersionEntry.Changes, 1) assert.Equal(t, firstVersionEntry.Version, secondVersion) - assert.Equal(t, changeTypeRelease, firstVersionEntry.ChangeType) + assert.Equal(t, changeTypeUpdate, firstVersionEntry.ChangeType) assert.Equal(t, "request-property-removed", firstVersionEntry.Changes[0].Code) assert.False(t, firstVersionEntry.Changes[0].BackwardCompatible) @@ -485,6 +485,7 @@ func TestMergeChangelogTwoVersionsWithDeprecations(t *testing.T) { Path: "/api/atlas/v2/groups/{groupId}/clusters", HTTPMethod: "POST", Tag: "Multi-Cloud Clusters", + Version: firstVersion, Sunset: sunset, ManualChangelogEntries: make(map[string]any), }, @@ -492,6 +493,7 @@ func TestMergeChangelogTwoVersionsWithDeprecations(t *testing.T) { Path: "/api/atlas/v2/groups/{groupId}/clusters", HTTPMethod: "POST", Tag: "Multi-Cloud Clusters", + Version: firstVersion, Sunset: "", ManualChangelogEntries: make(map[string]any), }, @@ -543,6 +545,7 @@ func TestMergeChangelogTwoVersionsWithDeprecations(t *testing.T) { changelog, err := changelogStruct.mergeChangelog(changeTypeFirstVersion, changesFirstVersion, endpointsConfig) require.NoError(t, err) + endpointsConfig["createCluster"].Revision.Version = secondVersion changelogStruct = &Changelog{ BaseMetadata: &Metadata{ @@ -584,14 +587,19 @@ func TestMergeChangelogTwoVersionsWithDeprecations(t *testing.T) { assert.True(t, firstVersionEntry.Changes[0].BackwardCompatible) assert.Equal(t, "endpoint-deprecated", firstVersionEntry.Changes[1].Code) assert.True(t, firstVersionEntry.Changes[1].BackwardCompatible) + assert.Equal(t, firstVersion, firstVersionEntry.Changes[1].DeprecatedVersion) + assert.Equal(t, sunset, firstVersionEntry.Changes[1].SunsetDate) + assert.Equal(t, secondVersion, firstVersionEntry.Changes[1].ReplacedByVersion) secondVersionEntry := versions[0] - require.Len(t, secondVersionEntry.Changes, 1) + require.Len(t, secondVersionEntry.Changes, 2) assert.Equal(t, secondVersionEntry.Version, secondVersion) assert.Equal(t, changeTypeRelease, secondVersionEntry.ChangeType) - assert.Equal(t, "request-property-removed", secondVersionEntry.Changes[0].Code) - assert.False(t, secondVersionEntry.Changes[0].BackwardCompatible) + assert.Equal(t, "endpoint-version-added", secondVersionEntry.Changes[0].Code) + assert.Equal(t, firstVersion, secondVersionEntry.Changes[0].ReplacesVersion) + assert.Equal(t, "request-property-removed", secondVersionEntry.Changes[1].Code) + assert.False(t, secondVersionEntry.Changes[1].BackwardCompatible) } func TestMergeChangelogWithDeprecations(t *testing.T) { @@ -611,6 +619,7 @@ func TestMergeChangelogWithDeprecations(t *testing.T) { Path: "/api/atlas/v2/groups/{groupId}/clusters", HTTPMethod: "POST", Tag: "Multi-Cloud Clusters", + Version: firstVersion, Sunset: sunset, ManualChangelogEntries: nil, }, @@ -618,6 +627,7 @@ func TestMergeChangelogWithDeprecations(t *testing.T) { Path: "/api/atlas/v2/groups/{groupId}/clusters", HTTPMethod: "POST", Tag: "Multi-Cloud Clusters", + Version: firstVersion, Sunset: "", ManualChangelogEntries: nil, }, @@ -669,6 +679,7 @@ func TestMergeChangelogWithDeprecations(t *testing.T) { changelog, err := changelogStruct.mergeChangelog(changeTypeFirstVersion, changesFirstVersion, endpointsConfig) require.NoError(t, err) + endpointsConfig["createCluster"].Revision.Version = secondVersion changelogStruct = &Changelog{ BaseMetadata: &Metadata{ @@ -708,12 +719,17 @@ func TestMergeChangelogWithDeprecations(t *testing.T) { assert.Equal(t, "endpoint-deprecated", firstVersionEntry.Changes[1].Code) assert.True(t, firstVersionEntry.Changes[1].BackwardCompatible) - assert.Contains(t, firstVersionEntry.Changes[1].Description, "deprecated and marked for removal on "+sunset) + assert.Contains(t, firstVersionEntry.Changes[1].Description, "deprecated and sunsets on "+sunset) + assert.Equal(t, firstVersion, firstVersionEntry.Changes[1].DeprecatedVersion) + assert.Equal(t, sunset, firstVersionEntry.Changes[1].SunsetDate) + assert.Equal(t, secondVersion, firstVersionEntry.Changes[1].ReplacedByVersion) secondVersionEntry := versions[0] - require.Len(t, secondVersionEntry.Changes, 1) - assert.Equal(t, "request-property-removed", secondVersionEntry.Changes[0].Code) - assert.False(t, secondVersionEntry.Changes[0].BackwardCompatible) + require.Len(t, secondVersionEntry.Changes, 2) + assert.Equal(t, "endpoint-version-added", secondVersionEntry.Changes[0].Code) + assert.Equal(t, firstVersion, secondVersionEntry.Changes[0].ReplacesVersion) + assert.Equal(t, "request-property-removed", secondVersionEntry.Changes[1].Code) + assert.False(t, secondVersionEntry.Changes[1].BackwardCompatible) } func TestMergeChangelogCompare(t *testing.T) { @@ -732,6 +748,7 @@ func TestMergeChangelogCompare(t *testing.T) { Path: "/api/atlas/v2/groups/{groupId}/clusters", HTTPMethod: "POST", Tag: "Multi-Cloud Clusters", + Version: firstVersion, Sunset: "2024-02-02", ManualChangelogEntries: nil, }, @@ -739,6 +756,7 @@ func TestMergeChangelogCompare(t *testing.T) { Path: "/api/atlas/v2/groups/{groupId}/clusters", HTTPMethod: "POST", Tag: "Multi-Cloud Clusters", + Version: firstVersion, Sunset: "2024-02-02", ManualChangelogEntries: nil, }, @@ -748,6 +766,7 @@ func TestMergeChangelogCompare(t *testing.T) { Path: "/api/atlas/v2/groups/{groupId}/clusters", HTTPMethod: "GET", Tag: "Multi-Cloud Clusters", + Version: firstVersion, Sunset: "2024-02-02", ManualChangelogEntries: nil, }, @@ -755,6 +774,7 @@ func TestMergeChangelogCompare(t *testing.T) { Path: "/api/atlas/v2/groups/{groupId}/clusters", HTTPMethod: "GET", Tag: "Multi-Cloud Clusters", + Version: firstVersion, Sunset: "2024-02-02", ManualChangelogEntries: nil, }, @@ -877,6 +897,12 @@ func TestMergeChangelogCompare(t *testing.T) { StabilityLevel: "stable", ChangeType: "release", Changes: []*Change{ + { + Description: "API version 2023-02-02 was added. It replaces API version 2023-01-01.", + Code: "endpoint-version-added", + BackwardCompatible: true, + ReplacesVersion: "2023-01-01", + }, { Description: "removed 'replicationSpecs.regionConfigs' response property", Code: "response-property-removed", @@ -895,9 +921,12 @@ func TestMergeChangelogCompare(t *testing.T) { BackwardCompatible: true, }, { - Description: "New resource added 2023-02-02. Resource version 2023-01-01 deprecated and marked for removal on 2024-02-02", + Description: "API version 2023-01-01 is deprecated and sunsets on 2024-02-02. Use API version 2023-02-02 instead.", Code: "endpoint-deprecated", BackwardCompatible: true, + DeprecatedVersion: "2023-01-01", + SunsetDate: "2024-02-02", + ReplacedByVersion: "2023-02-02", }, }, }, @@ -914,6 +943,12 @@ func TestMergeChangelogCompare(t *testing.T) { StabilityLevel: "stable", ChangeType: "release", Changes: []*Change{ + { + Description: "API version 2023-02-02 was added. It replaces API version 2023-01-01.", + Code: "endpoint-version-added", + BackwardCompatible: true, + ReplacesVersion: "2023-01-01", + }, { Description: "removed the request properties: 'mongoURIWithOptions', 'providerBackupEnabled'", Code: "request-property-removed", @@ -932,9 +967,12 @@ func TestMergeChangelogCompare(t *testing.T) { BackwardCompatible: true, }, { - Description: "New resource added 2023-02-02. Resource version 2023-01-01 deprecated and marked for removal on 2024-02-02", + Description: "API version 2023-01-01 is deprecated and sunsets on 2024-02-02. Use API version 2023-02-02 instead.", Code: "endpoint-deprecated", BackwardCompatible: true, + DeprecatedVersion: "2023-01-01", + SunsetDate: "2024-02-02", + ReplacedByVersion: "2023-02-02", }, }, }, @@ -998,6 +1036,8 @@ func TestMergeChangelogCompare(t *testing.T) { changelog, err := changelogStruct.mergeChangelog(changeTypeFirstVersion, changesFirstVersion, endpointsConfig) require.NoError(t, err) + endpointsConfig["createCluster"].Revision.Version = secondVersion + endpointsConfig["getClusters"].Revision.Version = secondVersion changelogStruct = &Changelog{ BaseMetadata: &Metadata{ diff --git a/tools/foas/changelog/outputfilter/operationconfig.go b/tools/foas/changelog/outputfilter/operationconfig.go index 23a64b0614..2581941ed0 100644 --- a/tools/foas/changelog/outputfilter/operationconfig.go +++ b/tools/foas/changelog/outputfilter/operationconfig.go @@ -2,6 +2,7 @@ package outputfilter import ( "github.com/getkin/kin-openapi/openapi3" + "github.com/mongodb/openapi/tools/foas/apiversion" "github.com/oasdiff/oasdiff/load" ) @@ -9,6 +10,7 @@ type OperationConfig struct { Path string HTTPMethod string Tag string + Version string Sunset string ManualChangelogEntries map[string]any } @@ -118,7 +120,69 @@ func newEndpointConfig(pathName, operatioName string, operation *openapi3.Operat Tag: tag, Path: pathName, HTTPMethod: operatioName, + Version: operationVersion(operation), Sunset: sunset, ManualChangelogEntries: manualChangelogEntries, } } + +// operationVersion returns the latest API version exposed by the operation, derived from the +// versions declared on its response and request-body media types. An operation may advertise +// several versioned media types; we take the greatest so that a per-version spec resolves to the +// single version it represents. Returns "" when no version can be determined. +func operationVersion(operation *openapi3.Operation) string { + var latest *apiversion.APIVersion + updateLatest := func(content openapi3.Content) { + for contentType, mediaType := range content { + version := versionFromMediaType(contentType, mediaType) + if version == nil { + continue + } + if latest == nil || version.GreaterThan(latest) { + latest = version + } + } + } + + if operation.Responses != nil { + for _, response := range operation.Responses.Map() { + if response == nil || response.Value == nil { + continue + } + updateLatest(response.Value.Content) + } + } + + if operation.RequestBody != nil && operation.RequestBody.Value != nil { + updateLatest(operation.RequestBody.Value.Content) + } + + if latest == nil { + return "" + } + return latest.String() +} + +// versionFromMediaType extracts the API version of a single media type. It prefers the +// x-xgen-version extension because it survives spec normalization (normalizeMediaType rewrites +// versioned content types such as application/vnd.atlas.2023-01-01+json to application/json but +// leaves the extension intact), which is the case the version-lifecycle changelog relies on. The +// content-type parsing is the fallback for non-normalized specs that still carry a versioned type. +func versionFromMediaType(contentType string, mediaType *openapi3.MediaType) *apiversion.APIVersion { + if mediaType == nil { + return nil + } + + if version, ok := mediaType.Extensions["x-xgen-version"].(string); ok && version != "" { + v, err := apiversion.New(apiversion.WithVersion(version)) + if err == nil { + return v + } + } + + v, err := apiversion.New(apiversion.WithFullContent(contentType, mediaType)) + if err != nil { + return nil + } + return v +} diff --git a/tools/foas/changelog/outputfilter/operationconfig_test.go b/tools/foas/changelog/outputfilter/operationconfig_test.go index 5bc4fd3b51..523b4bdeaf 100644 --- a/tools/foas/changelog/outputfilter/operationconfig_test.go +++ b/tools/foas/changelog/outputfilter/operationconfig_test.go @@ -7,9 +7,160 @@ import ( "github.com/getkin/kin-openapi/openapi3" "github.com/mongodb/openapi/tools/foas/openapi" "github.com/oasdiff/oasdiff/load" + "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) +func xgenMediaType(version string) *openapi3.MediaType { + return &openapi3.MediaType{Extensions: map[string]any{"x-xgen-version": version}} +} + +func responsesWithContent(content openapi3.Content) *openapi3.Responses { + return openapi3.NewResponses( + openapi3.WithStatus(200, &openapi3.ResponseRef{Value: &openapi3.Response{Content: content}}), + ) +} + +func TestVersionFromMediaType(t *testing.T) { + tests := []struct { + name string + contentType string + mediaType *openapi3.MediaType + expected string // "" means a nil version is expected + }{ + { + name: "nil media type", + mediaType: nil, + expected: "", + }, + { + name: "x-xgen-version extension takes precedence", + contentType: "application/json", + mediaType: xgenMediaType("2024-05-30"), + expected: "2024-05-30", + }, + { + name: "empty x-xgen-version falls back to content type", + contentType: "application/vnd.atlas.2023-01-01+json", + mediaType: xgenMediaType(""), + expected: "2023-01-01", + }, + { + name: "invalid x-xgen-version falls back to content type", + contentType: "application/vnd.atlas.2023-01-01+json", + mediaType: xgenMediaType("not-a-date"), + expected: "2023-01-01", + }, + { + name: "versioned content type without extension", + contentType: "application/vnd.atlas.2023-11-15+json", + mediaType: &openapi3.MediaType{}, + expected: "2023-11-15", + }, + { + name: "normalized content type without extension yields no version", + contentType: "application/json", + mediaType: &openapi3.MediaType{}, + expected: "", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := versionFromMediaType(tt.contentType, tt.mediaType) + if tt.expected == "" { + assert.Nil(t, got) + return + } + require.NotNil(t, got) + assert.Equal(t, tt.expected, got.String()) + }) + } +} + +func TestOperationVersion(t *testing.T) { + tests := []struct { + name string + operation *openapi3.Operation + expected string + }{ + { + name: "no responses or request body", + operation: &openapi3.Operation{}, + expected: "", + }, + { + name: "version from a single response media type", + operation: &openapi3.Operation{ + Responses: responsesWithContent(openapi3.Content{ + "application/vnd.atlas.2023-01-01+json": &openapi3.MediaType{}, + }), + }, + expected: "2023-01-01", + }, + { + name: "picks the latest version across response media types", + operation: &openapi3.Operation{ + Responses: responsesWithContent(openapi3.Content{ + "application/vnd.atlas.2023-01-01+json": &openapi3.MediaType{}, + "application/vnd.atlas.2024-05-30+json": &openapi3.MediaType{}, + "application/vnd.atlas.2023-11-15+json": &openapi3.MediaType{}, + }), + }, + expected: "2024-05-30", + }, + { + name: "version from request body only", + operation: &openapi3.Operation{ + RequestBody: &openapi3.RequestBodyRef{Value: &openapi3.RequestBody{ + Content: openapi3.Content{ + "application/vnd.atlas.2023-11-15+json": &openapi3.MediaType{}, + }, + }}, + }, + expected: "2023-11-15", + }, + { + name: "picks the latest version across responses and request body", + operation: &openapi3.Operation{ + Responses: responsesWithContent(openapi3.Content{ + "application/vnd.atlas.2023-01-01+json": &openapi3.MediaType{}, + }), + RequestBody: &openapi3.RequestBodyRef{Value: &openapi3.RequestBody{ + Content: openapi3.Content{ + "application/vnd.atlas.2024-05-30+json": &openapi3.MediaType{}, + }, + }}, + }, + expected: "2024-05-30", + }, + { + name: "version from x-xgen-version extension on normalized media type", + operation: &openapi3.Operation{ + Responses: responsesWithContent(openapi3.Content{ + "application/json": xgenMediaType("2023-11-15"), + }), + }, + expected: "2023-11-15", + }, + { + name: "no version when media types are unversioned", + operation: &openapi3.Operation{ + Responses: responsesWithContent(openapi3.Content{ + "application/json": &openapi3.MediaType{}, + }), + }, + expected: "", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + assert.Equal(t, tt.expected, operationVersion(tt.operation)) + }) + } +} + func TestOpenApiSpecMethods(t *testing.T) { loader := openapi.NewOpenAPI3().WithExcludedPrivatePaths() spec, err := loader.CreateOpenAPISpecFromPath("../../test/data/changelog/manual_generated_test_spec.json") @@ -20,6 +171,7 @@ func TestOpenApiSpecMethods(t *testing.T) { Path: "/api/atlas/v2/groups/{groupId}/clusters", HTTPMethod: "POST", Tag: "Multi-Cloud Clusters", + Version: "2023-01-01", Sunset: "2025-06-01", ManualChangelogEntries: map[string]any{}, }, @@ -27,6 +179,7 @@ func TestOpenApiSpecMethods(t *testing.T) { Path: "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", HTTPMethod: "DELETE", Tag: "Multi-Cloud Clusters", + Version: "2023-01-01", Sunset: "2025-06-01", ManualChangelogEntries: map[string]any{}, }, @@ -34,6 +187,7 @@ func TestOpenApiSpecMethods(t *testing.T) { Path: "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", HTTPMethod: "GET", Tag: "Multi-Cloud Clusters", + Version: "2023-01-01", Sunset: "2025-06-01", ManualChangelogEntries: map[string]any{ "2023-07-07": "July 7th changelog entry", @@ -44,6 +198,7 @@ func TestOpenApiSpecMethods(t *testing.T) { Path: "/api/atlas/v2/groups/{groupId}/clusters", HTTPMethod: "GET", Tag: "Multi-Cloud Clusters", + Version: "2023-01-01", Sunset: "2025-06-01", ManualChangelogEntries: map[string]any{}, }, @@ -51,6 +206,7 @@ func TestOpenApiSpecMethods(t *testing.T) { Path: "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", HTTPMethod: "PATCH", Tag: "Multi-Cloud Clusters", + Version: "2023-01-01", Sunset: "2025-06-01", ManualChangelogEntries: map[string]any{}, }, diff --git a/tools/foas/changelog/outputfilter/outputfilter.go b/tools/foas/changelog/outputfilter/outputfilter.go index f257ad0cbe..feeb2a2722 100644 --- a/tools/foas/changelog/outputfilter/outputfilter.go +++ b/tools/foas/changelog/outputfilter/outputfilter.go @@ -35,6 +35,10 @@ type OasDiffEntry struct { Source string `json:"source,omitempty"` Section string `json:"section"` HideFromChangelog bool `json:"hideFromChangelog,omitempty"` + DeprecatedVersion string `json:"deprecatedVersion,omitempty"` + SunsetDate string `json:"sunsetDate,omitempty"` + ReplacedByVersion string `json:"replacedByVersion,omitempty"` + ReplacesVersion string `json:"replacesVersion,omitempty"` } func (o *OasDiffEntry) LevelWithDefault() int { diff --git a/tools/foas/changelog/sunset.go b/tools/foas/changelog/sunset.go index 6b4eccf3e7..ed262424e9 100644 --- a/tools/foas/changelog/sunset.go +++ b/tools/foas/changelog/sunset.go @@ -24,8 +24,6 @@ import ( "github.com/oasdiff/oasdiff/checker" ) -const endpointRemovedCode = "endpoint-removed" - // newOasDiffEntriesFromSunsetEndpoints searches for resource versions marked for removal between // previous changelog run date and current date (inclusive), and that not already included in the changelog. // Returns a list of sunset endpoints with the same format as oasdiff results.