[Hub Generated] Review request for Microsoft.DocumentDB to add version preview/2021-10-15-preview #16211
Conversation
This file contains 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
…-07-01-preview to version 2021-10-15-preview
|
Hi, @niteshvijay1995 Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Per the Noun_Verb convention for Operation Ids, the noun 'GraphResources' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json#L1568 |
|
| 'PUT' operation 'CassandraResources_UpdateCassandraViewThroughput' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json#L5613 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DocumentDB/preview/2021-10-15-preview/dataTransferService.json#L290 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DocumentDB/preview/2021-10-15-preview/managedCassandra.json#L1290 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json#L5663 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json#L5712 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'GraphResources_CreateUpdateGraph' Request Model: 'GraphResourceCreateUpdateParameters' Response Model: 'GraphResourceGetResults' Location: Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json#L1520 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'SqlResources_CreateUpdateClientEncryptionKey' Request Model: 'ClientEncryptionKeyCreateUpdateParameters' Response Model: 'ClientEncryptionKeyGetResults' Location: Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json#L2012 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'CassandraResources_CreateUpdateCassandraView' Request Model: 'CassandraViewCreateUpdateParameters' Response Model: 'CassandraViewGetResults' Location: Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json#L5482 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'CassandraResources_UpdateCassandraViewThroughput' Request Model: 'ThroughputSettingsUpdateParameters' Response Model: 'ThroughputSettingsGetResults' Location: Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json#L5612 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'MongoDBResources_CreateUpdateMongoRoleDefinition' Request Model: 'MongoRoleDefinitionCreateUpdateParameters' Response Model: 'MongoRoleDefinitionGetResults' Location: Microsoft.DocumentDB/preview/2021-10-15-preview/mongorbac.json#L78 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'MongoDBResources_CreateUpdateMongoUserDefinition' Request Model: 'MongoUserDefinitionCreateUpdateParameters' Response Model: 'MongoUserDefinitionGetResults' Location: Microsoft.DocumentDB/preview/2021-10-15-preview/mongorbac.json#L259 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Service_Create' Request Model: 'ServiceResourceCreateUpdateParameters' Response Model: 'ServiceResource' Location: Microsoft.DocumentDB/preview/2021-10-15-preview/services.json#L80 |
|
| OperationId should contain the verb: 'migratetoautoscale' in:'CassandraResources_MigrateCassandraViewToAutoscale'. Consider updating the operationId Location: Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json#L5665 |
|
| OperationId should contain the verb: 'migratetomanualthroughput' in:'CassandraResources_MigrateCassandraViewToManualThroughput'. Consider updating the operationId Location: Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json#L5714 |
|
| The child tracked resource, 'clientEncryptionKeys' with immediate parent 'SqlDatabaseGetResults', must have a list by immediate parent operation. Location: Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json#L6158 |
|
| The child tracked resource, 'graphs' with immediate parent 'DatabaseAccountGetResults', must have a list by immediate parent operation. Location: Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json#L6320 |
|
| The child tracked resource, 'views' with immediate parent 'CassandraKeyspaceGetResults', must have a list by immediate parent operation. Location: Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json#L6777 |
|
| The child tracked resource, 'dataTransferJobs' with immediate parent 'DatabaseAccountGetResults', must have a list by immediate parent operation. Location: Microsoft.DocumentDB/preview/2021-10-15-preview/dataTransferService.json#L304 |
|
| The child tracked resource, 'backups' with immediate parent 'ClusterResource', must have a list by immediate parent operation. Location: Microsoft.DocumentDB/preview/2021-10-15-preview/managedCassandra.json#L1281 |
|
| The child tracked resource, 'mongodbRoleDefinitions' with immediate parent 'DatabaseAccountGetResults', must have a list by immediate parent operation. Location: Microsoft.DocumentDB/preview/2021-10-15-preview/mongorbac.json#L452 |
|
| The child tracked resource, 'mongodbUserDefinitions' with immediate parent 'DatabaseAccountGetResults', must have a list by immediate parent operation. Location: Microsoft.DocumentDB/preview/2021-10-15-preview/mongorbac.json#L567 |
|
| The child tracked resource, 'services' with immediate parent 'DatabaseAccountGetResults', must have a list by immediate parent operation. Location: Microsoft.DocumentDB/preview/2021-10-15-preview/services.json#L328 |
|
| 'jobCreateParameters' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.DocumentDB/preview/2021-10-15-preview/dataTransferService.json#L62 |
|
| 'resource' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json#L6178 |
The following errors/warnings exist before current PR submission:
Only 25 items are listed, please refer to log for more details.
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The JSON file has a circular reference. readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/preview/2021-10-15-preview/privateEndpointConnection.json |
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️Cross-Version Breaking Changes: 24 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.9.1)
- current:preview/2021-10-15-preview/cosmos-db.json compared with base:stable/2021-10-15/cosmos-db.json
- current:preview/2021-10-15-preview/cosmos-db.json compared with base:preview/2021-07-01-preview/cosmos-db.json
- current:preview/2021-10-15-preview/managedCassandra.json compared with base:stable/2021-10-15/managedCassandra.json
- current:preview/2021-10-15-preview/managedCassandra.json compared with base:preview/2021-07-01-preview/managedCassandra.json
- current:preview/2021-10-15-preview/notebook.json compared with base:stable/2021-10-15/notebook.json
- current:preview/2021-10-15-preview/notebook.json compared with base:preview/2021-07-01-preview/notebook.json
- current:preview/2021-10-15-preview/privateEndpointConnection.json compared with base:stable/2021-10-15/privateEndpointConnection.json
- current:preview/2021-10-15-preview/privateEndpointConnection.json compared with base:preview/2021-07-01-preview/privateEndpointConnection.json
- current:preview/2021-10-15-preview/privateLinkResources.json compared with base:stable/2021-10-15/privateLinkResources.json
- current:preview/2021-10-15-preview/privateLinkResources.json compared with base:preview/2021-07-01-preview/privateLinkResources.json
- current:preview/2021-10-15-preview/rbac.json compared with base:stable/2021-10-15/rbac.json
- current:preview/2021-10-15-preview/rbac.json compared with base:preview/2021-07-01-preview/rbac.json
- current:preview/2021-10-15-preview/restorable.json compared with base:stable/2021-10-15/restorable.json
- current:preview/2021-10-15-preview/restorable.json compared with base:preview/2021-07-01-preview/restorable.json
- current:preview/2021-10-15-preview/services.json compared with base:preview/2021-07-01-preview/services.json
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
This was referenced Sep 29, 2021
* Adds base for updating Microsoft.DocumentDB from version preview/2021-07-01-preview to version 2021-10-15-preview * Updates readme * Updates API version in new specs and examples * ClientEncryptionKey management API changes * Address semantics validation errors * Fix representation of wrappedDek * fix Swagger prettier formatting check * minor edits to address comments" * fix LintDiff error * Adds base for updating Microsoft.DocumentDB from version preview/2021-07-01-preview to version 2021-10-15-preview * Updates readme * Updates API version in new specs and examples * remove CreateUpdateOptions as they arent applicable for CEK * fix Model validation check Co-authored-by: anujtoshniwal <[email protected]> Co-authored-by: Anuj Toshniwal <[email protected]>
* mongo rbac cherry-pick * Removing entry for 07 preview Co-authored-by: kavskalyan <[email protected]>
|
Hi @niteshvijay1995, Your PR has some issues. Please fix the CI sequentially by following the order of
|
* preview swagger for managed cassandra * add cassandraAuditLoggingEnabled property * change property name in CommandPostBody Co-authored-by: Vivek Sundararajan <[email protected]>
Co-authored-by: Vivek Sundararajan <[email protected]>
* Adds base for updating Microsoft.DocumentDB from version preview/2021-07-01-preview to version 2021-10-15-preview * Updates readme * Updates API version in new specs and examples * Add DataTransfer job apis * Fix api version * Rename connection to endpointUrl * Rename connection to endpointUrl * Add dataTransferService in readme.md * Fix keys * Fix checks * Add worker count * Fix worker count
* Adding LatestRestorableTimestamp support for MongoDB * Fixing api version for examples.
* mongo rbac cherry-pick * Removing entry for 07 preview * Fixing swagger issues * Fixing swagger error for param * Fixing misplaced Description * Fixing model validation issues * Json pretty formatting * Fixing more model validation issues * Fixing type issue * Add password field for userdef request * Fixing URL param * Fixing URL param issue Co-authored-by: kavskalyan <[email protected]>
|
Please reply to Chris's comments. |
|
@mentat9 for some reason, I don't see an option to comment / reply on the individual comments you've left. I've made the suggested changes and also addressed your questions below.
Fixed.
It is already added - line 1969.
Added above while defining the operation. Line 1969. It is consistent with how other operations are defined.
We don't allow ClientEncryptionKeys to be deleted. If they are deleted, then the data would become useless since we won't be able to decrypt it anymore.
None of the properties are secret.
The properties are included as part of ClientEncryptionKeyGetResults. |
We are removing a required Property "CreateMode". We are not adding any new required property. |
Responding to your response: How do encryption keys get deleted when the data they are protecting is deleted? In reply to: 962281673 Refers to: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json:1974 in 5c95253. [](commit_id = 5c95253, deletion_comment = False) |
|
I did an update, but I'm handing off followups to @jorgecotillo who is oncall this week. Two of my comments are still active:
There are also some of Filiz's comments still active (I also added to one thread). |
ClientEncryptionKeys (CEKs) are child of Database resource. When the Database gets deleted, the CEKs are also deleted. |
Co-authored-by: Vivek Sundararajan <[email protected]>
jorgecotillo
added
the
ARMSignedOff
wmengmsft
approved these changes
Nov 13, 2021
This is intentionally done because we are planning to release other properties under the "capacity" group of properties. Right now, there's only one feature property under it, which is totalThroughputLimit. |
This was referenced Nov 15, 2021
Closed
LeiWang3
pushed a commit
to LeiWang3/azure-rest-api-specs
that referenced
this pull request
Mar 31, 2022
…n preview/2021-10-15-preview (Azure#16211) * Adds base for updating Microsoft.DocumentDB from version preview/2021-07-01-preview to version 2021-10-15-preview * Updates readme * Updates API version in new specs and examples * Antoshni cosmos db 2021 10 15 preview cek management (Azure#1) * Adds base for updating Microsoft.DocumentDB from version preview/2021-07-01-preview to version 2021-10-15-preview * Updates readme * Updates API version in new specs and examples * ClientEncryptionKey management API changes * Address semantics validation errors * Fix representation of wrappedDek * fix Swagger prettier formatting check * minor edits to address comments" * fix LintDiff error * Adds base for updating Microsoft.DocumentDB from version preview/2021-07-01-preview to version 2021-10-15-preview * Updates readme * Updates API version in new specs and examples * remove CreateUpdateOptions as they arent applicable for CEK * fix Model validation check Co-authored-by: anujtoshniwal <[email protected]> Co-authored-by: Anuj Toshniwal <[email protected]> * mongo rbac cherry-pick (Azure#5) * mongo rbac cherry-pick * Removing entry for 07 preview Co-authored-by: kavskalyan <[email protected]> * Revert "mongo rbac cherry-pick (Azure#5)" (Azure#7) This reverts commit 8392017. * preview swagger for managed cassandra (Azure#8) * preview swagger for managed cassandra * add cassandraAuditLoggingEnabled property * change property name in CommandPostBody Co-authored-by: Vivek Sundararajan <[email protected]> * fix validation, remove connectivity (Azure#11) Co-authored-by: Vivek Sundararajan <[email protected]> * Add data transfer job api (Azure#2) * Adds base for updating Microsoft.DocumentDB from version preview/2021-07-01-preview to version 2021-10-15-preview * Updates readme * Updates API version in new specs and examples * Add DataTransfer job apis * Fix api version * Rename connection to endpointUrl * Rename connection to endpointUrl * Add dataTransferService in readme.md * Fix keys * Fix checks * Add worker count * Fix worker count * MaterializedViewsBuilder (Azure#12) * Adding LatestRestorableTimestamp support for MongoDB collections. (Azure#9) * Adding LatestRestorableTimestamp support for MongoDB * Fixing api version for examples. * Mongo RBAC Swagger Changes (Azure#10) * mongo rbac cherry-pick * Removing entry for 07 preview * Fixing swagger issues * Fixing swagger error for param * Fixing misplaced Description * Fixing model validation issues * Json pretty formatting * Fixing more model validation issues * Fixing type issue * Add password field for userdef request * Fixing URL param * Fixing URL param issue Co-authored-by: kavskalyan <[email protected]> * TotalThroughput limit 10-15 preview API changes (Azure#6) * add backupStorageCustomerKeyUri and fix response status code (Azure#13) * fix validation, remove connectivity * add backupStorageCustomerKeyUri property * fix response status code Co-authored-by: Vivek Sundararajan <[email protected]> * Prettier fix * Fix Avocado check * Fix operationId * Fix operationId * Fix breaking change * Fix breaking change (managedCassandra invokeCommand) * Fix breaking change * Fix status code in example * Fix review comment * Use v3 version for resource-management * Fix client encryption review comments * update location header in example (Azure#15) Co-authored-by: Vivek Sundararajan <[email protected]> * Prettier fix * update header in response * formating json Co-authored-by: anujtoshniwal <[email protected]> Co-authored-by: Anuj Toshniwal <[email protected]> Co-authored-by: Abhijit Karanjkar <[email protected]> Co-authored-by: kavskalyan <[email protected]> Co-authored-by: vivek-microsoft <[email protected]> Co-authored-by: Vivek Sundararajan <[email protected]> Co-authored-by: Ajay Parulekar <[email protected]> Co-authored-by: Amit Singh <[email protected]> Co-authored-by: pjohari-ms <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.