From 5c498c847ad0d6e84fa13839cdcadc309fb5c3ae Mon Sep 17 00:00:00 2001 From: Vinh Trinh Date: Wed, 20 Jan 2021 10:42:17 -0800 Subject: [PATCH 01/11] clean up and add more descriptions --- .../preview/2020-06-01-preview/cosmos-db.json | 28 +++-- .../CosmosDBRestorableDatabaseAccountGet.json | 6 +- ...CosmosDBRestorableDatabaseAccountList.json | 12 +-- ...storableDatabaseAccountNoLocationList.json | 12 +-- .../2020-06-01-preview/restorable.json | 100 ++++++++++++------ 5 files changed, 104 insertions(+), 54 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json index 5c326dbdf557..ff78d3a42588 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json @@ -4193,7 +4193,7 @@ "$ref": "./examples/CosmosDBRestorableDatabaseAccountList.json" } }, - "description": "Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region.", + "description": "Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -4232,7 +4232,7 @@ "$ref": "./examples/CosmosDBRestorableDatabaseAccountNoLocationList.json" } }, - "description": "Lists all the restorable Azure Cosmos DB database accounts available under the subscription.", + "description": "Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -4268,7 +4268,7 @@ "$ref": "./examples/CosmosDBRestorableDatabaseAccountGet.json" } }, - "description": "Retrieves the properties of an existing Azure Cosmos DB restorable database account.", + "description": "Retrieves the properties of an existing Azure Cosmos DB restorable database account. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -7812,13 +7812,23 @@ "x-ms-client-flatten": true, "description": "The properties of a restorable database account.", "$ref": "#/definitions/RestorableDatabaseAccountProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." } - }, - "allOf": [ - { - "$ref": "#/definitions/ARMResourceProperties" - } - ] + } }, "RestorableDatabaseAccountProperties": { "type": "object", diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountGet.json index be54c7a508d7..6294d758bf49 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountGet.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountGet.json @@ -21,13 +21,13 @@ { "locationName": "South Central US", "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", - "creationTime": "2020-10-30T21:13:10.7486417Z", - "deletionTime": "2020-10-30T21:13:35.4466333Z" + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" }, { "locationName": "West US", "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", - "creationTime": "2020-10-30T21:13:10.7486417Z" + "creationTime": "2020-10-30T21:13:10Z" } ] } diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountList.json index 6c2184f2f63e..889b3726cc69 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountList.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountList.json @@ -22,13 +22,13 @@ { "locationName": "South Central US", "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", - "creationTime": "2020-10-30T21:13:10.7486417Z", - "deletionTime": "2020-10-30T21:13:35.4466333Z" + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" }, { "locationName": "West US", "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", - "creationTime": "2020-10-30T21:13:10.7486417Z" + "creationTime": "2020-10-30T21:13:10Z" } ] } @@ -46,13 +46,13 @@ { "locationName": "South Central US", "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", - "creationTime": "2020-10-30T21:13:10.7486417Z", - "deletionTime": "2020-10-30T21:13:35.4466333Z" + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" }, { "locationName": "West US", "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", - "creationTime": "2020-10-30T21:13:10.7486417Z" + "creationTime": "2020-10-30T21:13:10Z" } ] } diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json index 0c71af847561..be62497ad06b 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json @@ -21,13 +21,13 @@ { "locationName": "South Central US", "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", - "creationTime": "2020-10-30T21:13:10.7486417Z", - "deletionTime": "2020-10-30T21:13:35.4466333Z" + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" }, { "locationName": "West US", "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", - "creationTime": "2020-10-30T21:13:10.7486417Z" + "creationTime": "2020-10-30T21:13:10Z" } ] } @@ -45,13 +45,13 @@ { "locationName": "South Central US", "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", - "creationTime": "2020-10-30T21:13:10.7486417Z", - "deletionTime": "2020-10-30T21:13:35.4466333Z" + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" }, { "locationName": "West US", "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", - "creationTime": "2020-10-30T21:13:10.7486417Z" + "creationTime": "2020-10-30T21:13:10Z" } ] } diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json index 9a3d6b9b8a43..1654cac51c60 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json @@ -42,7 +42,7 @@ "$ref": "./examples/CosmosDBRestorableSqlDatabaseList.json" } }, - "description": "Lists all the restorable Azure Cosmos DB SQL databases available under the restorable account.", + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB SQL databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/*/read' permission", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -84,7 +84,7 @@ "$ref": "./examples/CosmosDBRestorableSqlContainerList.json" } }, - "description": "Lists all the restorable Azure Cosmos DB SQL containers available for a specific database.", + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB SQL container under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/*/read' permission", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -129,7 +129,7 @@ "$ref": "./examples/CosmosDBRestorableSqlResourceList.json" } }, - "description": "Lists all the restorable Azure Cosmos DB SQL resources available for a specific database account at a given time and location.", + "description": "Return a list of database and container combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/*/read' permission.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -177,7 +177,7 @@ "$ref": "./examples/CosmosDBRestorableMongodbDatabaseList.json" } }, - "description": "Lists all the restorable Azure Cosmos DB MongoDB databases available under the restorable account.", + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/*/read' permission", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -219,7 +219,7 @@ "$ref": "./examples/CosmosDBRestorableMongodbCollectionList.json" } }, - "description": "Lists all the restorable Azure Cosmos DB MongoDB collection available for a specific database.", + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB collections under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/*/read' permission", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -264,7 +264,7 @@ "$ref": "./examples/CosmosDBRestorableMongodbResourceList.json" } }, - "description": "Lists all the restorable Azure Cosmos DB MongoDB resources available for a specific database account at a given time and location.", + "description": "Return a list of database and collection combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/*/read' permission.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -328,13 +328,23 @@ "x-ms-client-flatten": true, "description": "The properties of a restorable SQL database.", "$ref": "#/definitions/RestorableSqlDatabaseProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." } - }, - "allOf": [ - { - "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/ARMResourceProperties" - } - ] + } }, "RestorableSqlDatabaseProperties": { "description": "The properties of an Azure Cosmos DB restorable SQL database", @@ -421,13 +431,23 @@ "x-ms-client-flatten": true, "description": "The properties of a restorable SQL container.", "$ref": "#/definitions/RestorableSqlContainerProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." } - }, - "allOf": [ - { - "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/ARMResourceProperties" - } - ] + } }, "RestorableSqlContainerProperties": { "description": "The properties of an Azure Cosmos DB restorable SQL container", @@ -517,13 +537,23 @@ "x-ms-client-flatten": true, "description": "The properties of a restorable MongoDB database.", "$ref": "#/definitions/RestorableMongodbDatabaseProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." } - }, - "allOf": [ - { - "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/ARMResourceProperties" - } - ] + } }, "RestorableMongodbDatabaseProperties": { "description": "The properties of an Azure Cosmos DB restorable MongoDB database", @@ -583,13 +613,23 @@ "x-ms-client-flatten": true, "description": "The properties of a restorable MongoDB collection.", "$ref": "#/definitions/RestorableMongodbCollectionProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." } - }, - "allOf": [ - { - "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/ARMResourceProperties" - } - ] + } }, "RestorableMongodbCollectionProperties": { "description": "The properties of an Azure Cosmos DB restorable MongoDB collection", From 2e029cf67ea7cc0d45f6ace77e01805e90bdf310 Mon Sep 17 00:00:00 2001 From: Vinh Trinh Date: Wed, 20 Jan 2021 10:52:04 -0800 Subject: [PATCH 02/11] add missing location --- .../preview/2020-06-01-preview/cosmos-db.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json index ff78d3a42588..aefd39feb732 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json @@ -7827,6 +7827,10 @@ "readOnly": true, "type": "string", "description": "The type of Azure resource." + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." } } }, From d191d86f072aac5025f6373c720c08d65fff8084 Mon Sep 17 00:00:00 2001 From: Vinh Trinh Date: Wed, 20 Jan 2021 11:33:09 -0800 Subject: [PATCH 03/11] fix small typo --- .../preview/2020-06-01-preview/restorable.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json index 1654cac51c60..af0e364784a9 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json @@ -84,7 +84,7 @@ "$ref": "./examples/CosmosDBRestorableSqlContainerList.json" } }, - "description": "Show the event feed of all mutations done on all the Azure Cosmos DB SQL container under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/*/read' permission", + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB SQL containers under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/*/read' permission", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" From 4bb66b28e7ea3ac1ac8f6493e11f324ab547e997 Mon Sep 17 00:00:00 2001 From: Vinh Trinh Date: Fri, 22 Jan 2021 18:59:01 -0800 Subject: [PATCH 04/11] update more descriptions --- .../2020-06-01-preview/restorable.json | 34 +++++++++++-------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json index af0e364784a9..cff8613c5d38 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json @@ -332,7 +332,7 @@ "id": { "readOnly": true, "type": "string", - "description": "The unique resource identifier of the ARM resource." + "description": "The unique resource IDentifier of the ARM resource." }, "name": { "readOnly": true, @@ -366,19 +366,21 @@ "eventTimestamp": { "type": "string", "readOnly": true, - "description": "The timestamp of this database event." + "description": "The time when this database event happened." }, "ownerId": { "type": "string", "readOnly": true, - "description": "The name of this restorable SQL database." + "description": "The name of the SQL database." }, "ownerResourceId": { "type": "string", "readOnly": true, - "description": "The resource Id of this restorable SQL database." + "description": "The resource ID of the SQL database." }, "database": { + "description": "The properties of an SQL database", + "type": "object", "properties": { "_colls": { "type": "string", @@ -435,7 +437,7 @@ "id": { "readOnly": true, "type": "string", - "description": "The unique resource identifier of the ARM resource." + "description": "The unique resource IDentifier of the ARM resource." }, "name": { "readOnly": true, @@ -469,7 +471,7 @@ "eventTimestamp": { "type": "string", "readOnly": true, - "description": "The timestamp of this container event." + "description": "The when this container event happened." }, "ownerId": { "type": "string", @@ -479,9 +481,11 @@ "ownerResourceId": { "type": "string", "readOnly": true, - "description": "The resource Id of this restorable SQL container." + "description": "The resource ID of this restorable SQL container." }, "container": { + "type": "object", + "description": "Cosmos DB SQL container resource object", "properties": { "_self": { "type": "string", @@ -541,7 +545,7 @@ "id": { "readOnly": true, "type": "string", - "description": "The unique resource identifier of the ARM resource." + "description": "The unique resource IDentifier of the ARM resource." }, "name": { "readOnly": true, @@ -575,7 +579,7 @@ "eventTimestamp": { "type": "string", "readOnly": true, - "description": "The timestamp of this database event." + "description": "The time when this database event happened." }, "ownerId": { "type": "string", @@ -585,7 +589,7 @@ "ownerResourceId": { "type": "string", "readOnly": true, - "description": "The resource Id of this restorable MongoDB database." + "description": "The resource ID of this restorable MongoDB database." } } } @@ -617,7 +621,7 @@ "id": { "readOnly": true, "type": "string", - "description": "The unique resource identifier of the ARM resource." + "description": "The unique resource IDentifier of the ARM resource." }, "name": { "readOnly": true, @@ -651,7 +655,7 @@ "eventTimestamp": { "type": "string", "readOnly": true, - "description": "The timestamp of this collection event." + "description": "The time when this collection event happened." }, "ownerId": { "type": "string", @@ -661,7 +665,7 @@ "ownerResourceId": { "type": "string", "readOnly": true, - "description": "The resource Id of this restorable MongoDB collection." + "description": "The resource ID of this restorable MongoDB collection." } } } @@ -703,7 +707,7 @@ "required": false, "type": "string", "x-ms-parameter-location": "method", - "description": "The resource id of the restorable SQL database." + "description": "The resource ID of the restorable SQL database." }, "restorableMongodbDatabaseRidParameter": { "name": "restorableMongodbDatabaseRid", @@ -711,7 +715,7 @@ "required": false, "type": "string", "x-ms-parameter-location": "method", - "description": "The resource id of the restorable Mongo database." + "description": "The resource ID of the restorable Mongo database." }, "restoreLocationParameter": { "name": "restoreLocation", From 06a920fd3deb53cff34fc662633346c305a3cb81 Mon Sep 17 00:00:00 2001 From: Vinh Trinh Date: Fri, 22 Jan 2021 19:30:14 -0800 Subject: [PATCH 05/11] remove restorables --- .../2020-06-01-preview/restorable.json | 66 +++++++++---------- 1 file changed, 32 insertions(+), 34 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json index cff8613c5d38..12afc8a39209 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json @@ -314,25 +314,25 @@ "items": { "$ref": "#/definitions/RestorableSqlDatabaseGetResult" }, - "description": "List of restorable SQL databases and their properties." + "description": "List of SQL database events and their properties." } }, - "description": "The List operation response, that contains the restorable SQL databases and their properties." + "description": "The List operation response, that contains the SQL database events and their properties." }, "RestorableSqlDatabaseGetResult": { - "description": "An Azure Cosmos DB restorable SQL database", + "description": "An Azure Cosmos DB SQL database event", "type": "object", "properties": { "properties": { "type": "object", "x-ms-client-flatten": true, - "description": "The properties of a restorable SQL database.", + "description": "The properties of a SQL database event.", "$ref": "#/definitions/RestorableSqlDatabaseProperties" }, "id": { "readOnly": true, "type": "string", - "description": "The unique resource IDentifier of the ARM resource." + "description": "The unique resource Identifier of the ARM resource." }, "name": { "readOnly": true, @@ -347,7 +347,7 @@ } }, "RestorableSqlDatabaseProperties": { - "description": "The properties of an Azure Cosmos DB restorable SQL database", + "description": "The properties of an Azure Cosmos DB SQL database event", "type": "object", "properties": { "resource": { @@ -379,8 +379,6 @@ "description": "The resource ID of the SQL database." }, "database": { - "description": "The properties of an SQL database", - "type": "object", "properties": { "_colls": { "type": "string", @@ -419,25 +417,25 @@ "items": { "$ref": "#/definitions/RestorableSqlContainerGetResult" }, - "description": "List of restorable SQL containers and their properties." + "description": "List of SQL container events and their properties." } }, - "description": "The List operation response, that contains the restorable SQL containers and their properties." + "description": "The List operation response, that contains the SQL container events and their properties." }, "RestorableSqlContainerGetResult": { - "description": "An Azure Cosmos DB restorable SQL container", + "description": "An Azure Cosmos DB SQL container event", "type": "object", "properties": { "properties": { "type": "object", "x-ms-client-flatten": true, - "description": "The properties of a restorable SQL container.", + "description": "The properties of a SQL container event.", "$ref": "#/definitions/RestorableSqlContainerProperties" }, "id": { "readOnly": true, "type": "string", - "description": "The unique resource IDentifier of the ARM resource." + "description": "The unique resource Identifier of the ARM resource." }, "name": { "readOnly": true, @@ -452,7 +450,7 @@ } }, "RestorableSqlContainerProperties": { - "description": "The properties of an Azure Cosmos DB restorable SQL container", + "description": "The properties of an Azure Cosmos DB SQL container event", "type": "object", "properties": { "resource": { @@ -476,12 +474,12 @@ "ownerId": { "type": "string", "readOnly": true, - "description": "The name of this restorable SQL container." + "description": "The name of this SQL container." }, "ownerResourceId": { "type": "string", "readOnly": true, - "description": "The resource ID of this restorable SQL container." + "description": "The resource ID of this SQL container." }, "container": { "type": "object", @@ -527,25 +525,25 @@ "items": { "$ref": "#/definitions/RestorableMongodbDatabaseGetResult" }, - "description": "List of restorable MongoDB databases and their properties." + "description": "List of MongoDB database events and their properties." } }, - "description": "The List operation response, that contains the restorable MongoDB databases and their properties." + "description": "The List operation response, that contains the MongoDB database events and their properties." }, "RestorableMongodbDatabaseGetResult": { - "description": "An Azure Cosmos DB restorable MongoDB database", + "description": "An Azure Cosmos DB MongoDB database event", "type": "object", "properties": { "properties": { "type": "object", "x-ms-client-flatten": true, - "description": "The properties of a restorable MongoDB database.", + "description": "The properties of a MongoDB database event.", "$ref": "#/definitions/RestorableMongodbDatabaseProperties" }, "id": { "readOnly": true, "type": "string", - "description": "The unique resource IDentifier of the ARM resource." + "description": "The unique resource Identifier of the ARM resource." }, "name": { "readOnly": true, @@ -560,7 +558,7 @@ } }, "RestorableMongodbDatabaseProperties": { - "description": "The properties of an Azure Cosmos DB restorable MongoDB database", + "description": "The properties of an Azure Cosmos DB MongoDB database event", "type": "object", "properties": { "resource": { @@ -584,12 +582,12 @@ "ownerId": { "type": "string", "readOnly": true, - "description": "The name of this restorable MongoDB database." + "description": "The name of this MongoDB database." }, "ownerResourceId": { "type": "string", "readOnly": true, - "description": "The resource ID of this restorable MongoDB database." + "description": "The resource ID of this MongoDB database." } } } @@ -603,25 +601,25 @@ "items": { "$ref": "#/definitions/RestorableMongodbCollectionGetResult" }, - "description": "List of restorable MongoDB collections and their properties." + "description": "List of MongoDB collection events and their properties." } }, - "description": "The List operation response, that contains the restorable MongoDB collections and their properties." + "description": "The List operation response, that contains the MongoDB collection events and their properties." }, "RestorableMongodbCollectionGetResult": { - "description": "An Azure Cosmos DB restorable MongoDB collection", + "description": "An Azure Cosmos DB MongoDB collection event", "type": "object", "properties": { "properties": { "type": "object", "x-ms-client-flatten": true, - "description": "The properties of a restorable MongoDB collection.", + "description": "The properties of a MongoDB collection event.", "$ref": "#/definitions/RestorableMongodbCollectionProperties" }, "id": { "readOnly": true, "type": "string", - "description": "The unique resource IDentifier of the ARM resource." + "description": "The unique resource Identifier of the ARM resource." }, "name": { "readOnly": true, @@ -636,7 +634,7 @@ } }, "RestorableMongodbCollectionProperties": { - "description": "The properties of an Azure Cosmos DB restorable MongoDB collection", + "description": "The properties of an Azure Cosmos DB MongoDB collection event", "type": "object", "properties": { "resource": { @@ -660,12 +658,12 @@ "ownerId": { "type": "string", "readOnly": true, - "description": "The name of this restorable MongoDB collection." + "description": "The name of this MongoDB collection." }, "ownerResourceId": { "type": "string", "readOnly": true, - "description": "The resource ID of this restorable MongoDB collection." + "description": "The resource ID of this MongoDB collection." } } } @@ -707,7 +705,7 @@ "required": false, "type": "string", "x-ms-parameter-location": "method", - "description": "The resource ID of the restorable SQL database." + "description": "The resource ID of the SQL database." }, "restorableMongodbDatabaseRidParameter": { "name": "restorableMongodbDatabaseRid", @@ -715,7 +713,7 @@ "required": false, "type": "string", "x-ms-parameter-location": "method", - "description": "The resource ID of the restorable Mongo database." + "description": "The resource ID of the MongoDB database." }, "restoreLocationParameter": { "name": "restoreLocation", From ca2a3909e0f72f9618039dddd34a5ef78e5ab4e1 Mon Sep 17 00:00:00 2001 From: Vinh Trinh Date: Fri, 22 Jan 2021 19:48:38 -0800 Subject: [PATCH 06/11] add missing descriptions --- .../preview/2020-06-01-preview/restorable.json | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json index 12afc8a39209..50c0d0b11353 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json @@ -351,6 +351,8 @@ "type": "object", "properties": { "resource": { + "type": "object", + "description": "The resource of an Azure Cosmos DB SQL database event", "properties": { "_rid": { "type": "string", @@ -379,6 +381,8 @@ "description": "The resource ID of the SQL database." }, "database": { + "type": "object", + "description": "Cosmos DB SQL database resource object", "properties": { "_colls": { "type": "string", @@ -454,6 +458,8 @@ "type": "object", "properties": { "resource": { + "description": "The resource of an Azure Cosmos DB SQL container event", + "type": "object", "properties": { "_rid": { "type": "string", @@ -561,6 +567,8 @@ "description": "The properties of an Azure Cosmos DB MongoDB database event", "type": "object", "properties": { + "description": "The resource of an Azure Cosmos DB MongoDB database event", + "type": "object", "resource": { "properties": { "_rid": { @@ -637,6 +645,8 @@ "description": "The properties of an Azure Cosmos DB MongoDB collection event", "type": "object", "properties": { + "description": "The resource of an Azure Cosmos DB MongoDB collection event", + "type": "object", "resource": { "properties": { "_rid": { From d94108c6757ca03c387f395426bd15de04342eef Mon Sep 17 00:00:00 2001 From: Vinh Trinh Date: Fri, 22 Jan 2021 20:00:24 -0800 Subject: [PATCH 07/11] fix resource --- .../preview/2020-06-01-preview/restorable.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json index 50c0d0b11353..74287beaa71e 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json @@ -567,9 +567,9 @@ "description": "The properties of an Azure Cosmos DB MongoDB database event", "type": "object", "properties": { - "description": "The resource of an Azure Cosmos DB MongoDB database event", - "type": "object", "resource": { + "description": "The resource of an Azure Cosmos DB MongoDB database event", + "type": "object", "properties": { "_rid": { "type": "string", @@ -645,9 +645,9 @@ "description": "The properties of an Azure Cosmos DB MongoDB collection event", "type": "object", "properties": { - "description": "The resource of an Azure Cosmos DB MongoDB collection event", - "type": "object", "resource": { + "description": "The resource of an Azure Cosmos DB MongoDB collection event", + "type": "object", "properties": { "_rid": { "type": "string", From b1c47e8f01f7d683e3c323236473f296eacdd651 Mon Sep 17 00:00:00 2001 From: Vinh Trinh Date: Fri, 22 Jan 2021 21:05:03 -0800 Subject: [PATCH 08/11] pretty --- .../preview/2020-06-01-preview/restorable.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json index 74287beaa71e..e09cb146dc48 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json @@ -352,7 +352,7 @@ "properties": { "resource": { "type": "object", - "description": "The resource of an Azure Cosmos DB SQL database event", + "description": "The resource of an Azure Cosmos DB SQL database event", "properties": { "_rid": { "type": "string", @@ -382,7 +382,7 @@ }, "database": { "type": "object", - "description": "Cosmos DB SQL database resource object", + "description": "Cosmos DB SQL database resource object", "properties": { "_colls": { "type": "string", @@ -459,7 +459,7 @@ "properties": { "resource": { "description": "The resource of an Azure Cosmos DB SQL container event", - "type": "object", + "type": "object", "properties": { "_rid": { "type": "string", @@ -569,7 +569,7 @@ "properties": { "resource": { "description": "The resource of an Azure Cosmos DB MongoDB database event", - "type": "object", + "type": "object", "properties": { "_rid": { "type": "string", @@ -647,7 +647,7 @@ "properties": { "resource": { "description": "The resource of an Azure Cosmos DB MongoDB collection event", - "type": "object", + "type": "object", "properties": { "_rid": { "type": "string", From 46cb01f92c8926bf6b2bfc614c1b866d59c37726 Mon Sep 17 00:00:00 2001 From: Vinh Trinh Date: Thu, 28 Jan 2021 10:24:41 -0800 Subject: [PATCH 09/11] unflatten --- .../preview/2020-06-01-preview/restorable.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json index e09cb146dc48..e12f18f61ed1 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json @@ -325,7 +325,7 @@ "properties": { "properties": { "type": "object", - "x-ms-client-flatten": true, + "x-ms-client-flatten": false, "description": "The properties of a SQL database event.", "$ref": "#/definitions/RestorableSqlDatabaseProperties" }, @@ -432,7 +432,7 @@ "properties": { "properties": { "type": "object", - "x-ms-client-flatten": true, + "x-ms-client-flatten": false, "description": "The properties of a SQL container event.", "$ref": "#/definitions/RestorableSqlContainerProperties" }, @@ -542,7 +542,7 @@ "properties": { "properties": { "type": "object", - "x-ms-client-flatten": true, + "x-ms-client-flatten": false, "description": "The properties of a MongoDB database event.", "$ref": "#/definitions/RestorableMongodbDatabaseProperties" }, @@ -620,7 +620,7 @@ "properties": { "properties": { "type": "object", - "x-ms-client-flatten": true, + "x-ms-client-flatten": false, "description": "The properties of a MongoDB collection event.", "$ref": "#/definitions/RestorableMongodbCollectionProperties" }, From b563c2f3e85e4891c4ad23209dc93f9b322fbb52 Mon Sep 17 00:00:00 2001 From: Vinh Trinh Date: Thu, 28 Jan 2021 11:05:16 -0800 Subject: [PATCH 10/11] remove flatten --- .../preview/2020-06-01-preview/restorable.json | 4 ---- 1 file changed, 4 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json index e12f18f61ed1..5d377fdbdafc 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json @@ -325,7 +325,6 @@ "properties": { "properties": { "type": "object", - "x-ms-client-flatten": false, "description": "The properties of a SQL database event.", "$ref": "#/definitions/RestorableSqlDatabaseProperties" }, @@ -432,7 +431,6 @@ "properties": { "properties": { "type": "object", - "x-ms-client-flatten": false, "description": "The properties of a SQL container event.", "$ref": "#/definitions/RestorableSqlContainerProperties" }, @@ -542,7 +540,6 @@ "properties": { "properties": { "type": "object", - "x-ms-client-flatten": false, "description": "The properties of a MongoDB database event.", "$ref": "#/definitions/RestorableMongodbDatabaseProperties" }, @@ -620,7 +617,6 @@ "properties": { "properties": { "type": "object", - "x-ms-client-flatten": false, "description": "The properties of a MongoDB collection event.", "$ref": "#/definitions/RestorableMongodbCollectionProperties" }, From 197836bdf257ef8b527c51d7dd603572e4b99869 Mon Sep 17 00:00:00 2001 From: Vinh Trinh Date: Fri, 29 Jan 2021 16:04:08 -0800 Subject: [PATCH 11/11] remove flatten --- .../preview/2020-06-01-preview/cosmos-db.json | 4 ++-- .../preview/2020-06-01-preview/restorable.json | 4 ++++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json index aefd39feb732..2741745de29d 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json @@ -4193,7 +4193,7 @@ "$ref": "./examples/CosmosDBRestorableDatabaseAccountList.json" } }, - "description": "Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.", + "description": "Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -4232,7 +4232,7 @@ "$ref": "./examples/CosmosDBRestorableDatabaseAccountNoLocationList.json" } }, - "description": "Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.", + "description": "Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json index 5d377fdbdafc..e09cb146dc48 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json @@ -325,6 +325,7 @@ "properties": { "properties": { "type": "object", + "x-ms-client-flatten": true, "description": "The properties of a SQL database event.", "$ref": "#/definitions/RestorableSqlDatabaseProperties" }, @@ -431,6 +432,7 @@ "properties": { "properties": { "type": "object", + "x-ms-client-flatten": true, "description": "The properties of a SQL container event.", "$ref": "#/definitions/RestorableSqlContainerProperties" }, @@ -540,6 +542,7 @@ "properties": { "properties": { "type": "object", + "x-ms-client-flatten": true, "description": "The properties of a MongoDB database event.", "$ref": "#/definitions/RestorableMongodbDatabaseProperties" }, @@ -617,6 +620,7 @@ "properties": { "properties": { "type": "object", + "x-ms-client-flatten": true, "description": "The properties of a MongoDB collection event.", "$ref": "#/definitions/RestorableMongodbCollectionProperties" },