Swagger changes to introduce REST APIs for offline and online region for the Cosmos DB account #2962
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -337,6 +337,76 @@ | |
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/offlineRegion": { | ||
| "post": { | ||
| "operationId": "DatabaseAccounts_OfflineRegion", | ||
| "x-ms-examples": { | ||
| "CosmosDBDatabaseAccountOfflineRegion": { "$ref": "./examples/CosmosDBDatabaseAccountOfflineRegion.json" } | ||
| }, | ||
| "description": "Offline the specified region for the specified Azure Cosmos DB database account.", | ||
| "x-ms-long-running-operation": true, | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/subscriptionIdParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/resourceGroupNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/accountNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/apiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/regionParameterForOnlineOffline" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "The offline region operation is completed successfully." | ||
| }, | ||
| "202": { | ||
| "description": "Accepted. The offline region operation will complete asynchronously." | ||
| } | ||
| } | ||
|
Member
There was a problem hiding this comment. seems this is a long running operation, if so please add
Contributor
Author
There was a problem hiding this comment. @anuchandy I have fixed based on your comment. Can you please review. |
||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/onlineRegion": { | ||
| "post": { | ||
| "operationId": "DatabaseAccounts_OnlineRegion", | ||
| "x-ms-examples": { | ||
| "CosmosDBDatabaseAccountOnlineRegion": { "$ref": "./examples/CosmosDBDatabaseAccountOnlineRegion.json" } | ||
| }, | ||
| "description": "Online the specified region for the specified Azure Cosmos DB database account.", | ||
| "x-ms-long-running-operation": true, | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/subscriptionIdParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/resourceGroupNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/accountNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/apiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/regionParameterForOnlineOffline" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "The online region operation is completed successfully." | ||
| }, | ||
| "202": { | ||
| "description": "Accepted. The online region operation will complete asynchronously." | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys": { | ||
| "get": { | ||
| "operationId": "DatabaseAccounts_ListReadOnlyKeys", | ||
|
|
@@ -2271,6 +2341,14 @@ | |
| "x-ms-parameter-location": "method", | ||
| "description": "Cosmos DB region, with spaces between words and each word capitalized." | ||
| }, | ||
| "regionParameterForOnlineOffline": { | ||
| "name": "region", | ||
| "in": "query", | ||
| "required": true, | ||
| "type": "string", | ||
| "x-ms-parameter-location": "method", | ||
| "description": "Cosmos DB region, with spaces between words and each word capitalized." | ||
| }, | ||
| "sourceRegionParameter": { | ||
| "name": "sourceRegion", | ||
| "in": "path", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "parameters": { | ||
| "accountName": "ddb1", | ||
| "resourceGroupName": "rg1", | ||
| "api-version": "2015-04-08", | ||
| "subscriptionId": "subid", | ||
| "region":"North Europe" | ||
| }, | ||
| "responses": { | ||
| "200": { }, | ||
| "202": { } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "parameters": { | ||
| "accountName": "ddb1", | ||
| "resourceGroupName": "rg1", | ||
| "api-version": "2015-04-08", | ||
| "subscriptionId": "subid", | ||
| "region":"North Europe" | ||
| }, | ||
| "responses": { | ||
| "200": { }, | ||
| "202": { } | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a "default" response to capture all the error responses. The schema complies with ARM RPC error contract. Example can be found Batch RP swagger spec.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ravbhatnagar I have added a default error response. Can you please review.