Swagger changes to introduce REST APIs for offline and online region for the Cosmos DB account by arsalana-microsoft · Pull Request #2962 · Azure/azure-rest-api-specs

arsalana-microsoft · 2018-04-26T23:07:36Z

This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.

PR information

The title of the PR is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
If applicable, the PR references the bug/issue that it fixes.
Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

I have read the contribution guidelines.
My spec meets the review criteria:
- The spec conforms to the Swagger 2.0 specification.
- The spec follows the guidelines described in the Swagger checklist document.
- Validation tools were run on swagger spec(s) and have all been fixed in this PR.

msftclas · 2018-04-26T23:07:47Z

All CLA requirements met.

azuresdkciprbot · 2018-04-26T23:15:28Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(6 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-26T23:15:28Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

2 new Warnings.(15 total)

Code	Id	Source	Message
LongRunningOperationsWithLongRunningExtension	R2007	Link	The operation 'DatabaseAccounts_OfflineRegion' returns 202 status code, which indicates a long running operation, please enable "x-ms-long-running-operation.
LongRunningOperationsWithLongRunningExtension	R2007	Link	The operation 'DatabaseAccounts_OnlineRegion' returns 202 status code, which indicates a long running operation, please enable "x-ms-long-running-operation.

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

AutorestCI · 2018-04-26T23:23:09Z

Automation for azure-libraries-for-java

The initial PR has been merged into your service PR:
AutorestCI/azure-libraries-for-java#58

azuresdkciprbot · 2018-04-26T23:35:21Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(13 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-26T23:35:21Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(6 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-26T23:42:20Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(13 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-26T23:42:20Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(6 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

AutorestCI · 2018-04-27T00:04:36Z

Automation for azure-sdk-for-node

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-node#2728

AutorestCI · 2018-04-27T00:05:34Z

Automation for azure-sdk-for-python

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-python#2556

azuresdkciprbot · 2018-04-27T00:12:45Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(13 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-27T00:12:45Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(6 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

AutorestCI · 2018-04-27T00:46:15Z

Automation for azure-sdk-for-go

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-go#1821

azuresdkciprbot · 2018-04-27T00:54:22Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(6 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-27T00:54:22Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(13 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

anuchandy · 2018-04-27T05:05:33Z

specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json

+          "202": {
+            "description": "Accepted. The offline region operation will complete asynchronously."
+          }
+        }


seems this is a long running operation, if so please add "x-ms-long-running-operation": true attribute for both operations

@anuchandy I have fixed based on your comment. Can you please review.

azuresdkciprbot · 2018-04-30T22:07:43Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-30T22:07:43Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

…instead of body

azuresdkciprbot · 2018-04-30T23:05:28Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-30T23:05:28Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

…instead of body

azuresdkciprbot · 2018-04-30T23:33:40Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(6 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-30T23:33:40Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

2 new Warnings.(15 total)

Code	Id	Source	Message
ParameterDescriptionRequired	R4000	Link	'regionParameterForOffline' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation.
ParameterDescriptionRequired	R4000	Link	'regionParameterForOnline' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation.

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

…instead of body and adding the description

azuresdkciprbot · 2018-04-30T23:44:51Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(13 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-30T23:44:51Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(6 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

anuchandy

See review comment on LRO.

azuresdkciprbot · 2018-05-01T22:37:38Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(6 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-01T22:37:38Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(13 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

anuchandy · 2018-05-02T20:55:05Z

@ravbhatnagar could you please take a look?

anuchandy · 2018-05-07T18:31:52Z

@ravbhatnagar can you please take a look?

ravbhatnagar · 2018-05-08T08:35:27Z

specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json

+            }
+          }
+        ],
+        "responses": {


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.

@ravbhatnagar I have added a default error response. Can you please review.

ravbhatnagar · 2018-05-08T08:36:17Z

Just one minor thing. Rest looks good. Signing off from ARM.

azuresdkciprbot · 2018-05-08T21:20:39Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(6 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-08T21:20:39Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cosmos-db/resource-manager/readme.md

⚠️

0 new Warnings.(13 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

Swagger changes to introduce REST APIs for offline and online region

fc2e0c2

azuresdkci assigned anuchandy Apr 26, 2018

azuresdkci requested a review from anuchandy April 26, 2018 23:08

mark the offline and online apis as long running operations

754d78c

arsalana-microsoft closed this Apr 26, 2018

arsalana-microsoft reopened this Apr 26, 2018

fix the compiling error for the json

f874740

AutorestCI mentioned this pull request Apr 27, 2018

[AutoPR cosmos-db/resource-manager] Swagger changes to introduce REST APIs for offline and online region for the Cosmos DB account Azure/azure-sdk-for-go#1715

Closed

define a new region parameter for online/offline

fa9bc30

anuchandy reviewed Apr 27, 2018

View reviewed changes

anuchandy requested a review from ravbhatnagar April 27, 2018 05:07

anuchandy added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 27, 2018

fix the bug where the region parameter was part of query instead of body

8a4a624

actually fixing the bug where the region parameter was part of query …

42bc198

…instead of body

actually fixing the bug where the region parameter was part of query …

ab30108

…instead of body

actually fixing the bug where the region parameter was part of query …

05246bc

…instead of body and adding the description

anuchandy requested changes May 1, 2018

View reviewed changes

another try to specify the correct swagger changes

f2366fb

AutorestCI mentioned this pull request May 1, 2018

[AutoPR cosmos-db/resource-manager] Swagger changes to introduce REST APIs for offline and online region for the Cosmos DB account Azure/azure-sdk-for-go#1751

Merged

sujitvk1 approved these changes May 2, 2018

View reviewed changes

ravbhatnagar reviewed May 8, 2018

View reviewed changes

ravbhatnagar added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 8, 2018

Added default error response

9057135

anuchandy approved these changes May 9, 2018

View reviewed changes

anuchandy merged commit 1dd7d6d into Azure:master May 9, 2018

Conversation

arsalana-microsoft commented Apr 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR information

Quality of Swagger

Uh oh!

msftclas commented Apr 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azuresdkciprbot commented Apr 26, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented Apr 26, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

AutorestCI commented Apr 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-libraries-for-java

Uh oh!

azuresdkciprbot commented Apr 26, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented Apr 26, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented Apr 26, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented Apr 26, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

AutorestCI commented Apr 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-node

Uh oh!

AutorestCI commented Apr 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-python

Uh oh!

azuresdkciprbot commented Apr 27, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented Apr 27, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

AutorestCI commented Apr 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-go

Uh oh!

azuresdkciprbot commented Apr 27, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented Apr 27, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

anuchandy Apr 27, 2018

Choose a reason for hiding this comment

Uh oh!

arsalana-microsoft May 1, 2018

Choose a reason for hiding this comment

Uh oh!

arsalana-microsoft May 8, 2018

Choose a reason for hiding this comment

Uh oh!

azuresdkciprbot commented Apr 30, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented Apr 30, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented Apr 30, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented Apr 30, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented Apr 30, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented Apr 30, 2018

arsalana-microsoft commented Apr 26, 2018 •

edited

Loading

msftclas commented Apr 26, 2018 •

edited

Loading

AutorestCI commented Apr 26, 2018 •

edited

Loading

AutorestCI commented Apr 27, 2018 •

edited

Loading

AutorestCI commented Apr 27, 2018 •

edited

Loading

AutorestCI commented Apr 27, 2018 •

edited

Loading