Release Cosmos db microsoft.document db 2022 11 15 preview #21555
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
…-08-15-preview to version 2022-11-15-preview
Introduces 'EnableBurstCapacity' in DatabaseAccountProperties
|
Hi, @rsharm7 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. vscswagger@microsoft.com |
ghost
added
the
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| cosmos-db.json | 2022-11-15-preview(b9799cf) | 2022-11-15(main) |
| cosmos-db.json | 2022-11-15-preview(b9799cf) | 2022-08-15-preview(main) |
| dataTransferService.json | 2022-11-15-preview(b9799cf) | 2022-08-15-preview(main) |
| managedCassandra.json | 2022-11-15-preview(b9799cf) | 2022-11-15(main) |
| managedCassandra.json | 2022-11-15-preview(b9799cf) | 2022-08-15-preview(main) |
| mongorbac.json | 2022-11-15-preview(b9799cf) | 2022-11-15(main) |
| mongorbac.json | 2022-11-15-preview(b9799cf) | 2022-08-15-preview(main) |
| notebook.json | 2022-11-15-preview(b9799cf) | 2022-11-15(main) |
| notebook.json | 2022-11-15-preview(b9799cf) | 2022-08-15-preview(main) |
| privateEndpointConnection.json | 2022-11-15-preview(b9799cf) | 2022-11-15(main) |
| privateEndpointConnection.json | 2022-11-15-preview(b9799cf) | 2022-08-15-preview(main) |
| privateLinkResources.json | 2022-11-15-preview(b9799cf) | 2022-11-15(main) |
| privateLinkResources.json | 2022-11-15-preview(b9799cf) | 2022-08-15-preview(main) |
| rbac.json | 2022-11-15-preview(b9799cf) | 2022-11-15(main) |
| rbac.json | 2022-11-15-preview(b9799cf) | 2022-08-15-preview(main) |
| restorable.json | 2022-11-15-preview(b9799cf) | 2022-11-15(main) |
| restorable.json | 2022-11-15-preview(b9799cf) | 2022-08-15-preview(main) |
| services.json | 2022-11-15-preview(b9799cf) | 2022-11-15(main) |
| services.json | 2022-11-15-preview(b9799cf) | 2022-08-15-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
Only 19 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 26 Errors, 32 Warnings failed [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-11 | package-preview-2022-11(b9799cf) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 19 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The resource name parameter 'graphName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L1535 |
RPC-Uri-V1-05 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2385 |
RPC-Uri-V1-05 |
|
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2385 |
RPC-Uri-V1-05 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2673 |
RPC-Uri-V1-05 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2741 |
RPC-Uri-V1-05 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2809 |
RPC-Uri-V1-05 |
|
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2809 |
RPC-Uri-V1-05 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2880 |
RPC-Uri-V1-05 |
|
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2880 |
RPC-Uri-V1-05 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L3939 |
RPC-Uri-V1-05 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L4007 |
RPC-Uri-V1-05 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L4075 |
RPC-Uri-V1-05 |
|
The resource name parameter 'collectionName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L4075 |
RPC-Uri-V1-05 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L4146 |
RPC-Uri-V1-05 |
|
The resource name parameter 'collectionName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L4146 |
RPC-Uri-V1-05 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L4406 |
RPC-Uri-V1-05 |
|
The resource name parameter 'collectionName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L4406 |
RPC-Uri-V1-05 |
|
The resource name parameter 'keyspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L6709 |
RPC-Uri-V1-05 |
|
The resource name parameter 'keyspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L6748 |
RPC-Uri-V1-05 |
The following errors/warnings exist before current PR submission:
Only 19 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L435 |
|
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L494 |
|
The response schema of operations API '/providers/Microsoft.DocumentDB/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L667 |
|
The path for nested resource doest not meet the valid resource pattern. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L938 |
|
The path for nested resource doest not meet the valid resource pattern. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L980 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L1712 |
|
The resource ThroughputSettingsGetResults does not have a corresponding delete operation. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L1853 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L1853 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L1946 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2002 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2058 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2097 |
|
The resource name parameter 'clientEncryptionKeyName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2097 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2196 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2235 |
|
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2235 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2456 |
|
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2456 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L2555 |
️❌Avocado: 2 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/cassandraClusters/{}/repair is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/preview/2021-07-01-preview/managedCassandra.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/cassandraClusters/{}/fetchNodeStatus is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/preview/2021-07-01-preview/managedCassandra.json |
| The JSON file has a circular reference. readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/preview/2022-11-15-preview/privateEndpointConnection.json |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 407 Errors, 0 Warnings failed [Detail]
Tag package-preview-2022-11; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 220, untested: 0, failed: 176, passed: 44
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 19 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Additional properties not allowed: enablePartitionKeyMonitor Source: response OperationId: DatabaseAccounts_CreateOrUpdate |
|
Additional properties not allowed: EnabledApiTypes Source: response OperationId: DatabaseAccounts_CreateOrUpdate |
|
Additional properties not allowed: configurationOverrides Source: response OperationId: DatabaseAccounts_CreateOrUpdate |
|
statusCode: 400, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: DatabaseAccounts_ListUsages |
|
The swagger file does not define '400' response code Source: response OperationId: DatabaseAccounts_ListUsages |
|
statusCode: 400, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: DatabaseAccounts_ListMetrics |
|
The swagger file does not define '400' response code Source: response OperationId: DatabaseAccounts_ListMetrics |
|
Additional properties not allowed: sqlEndpoint Source: response OperationId: DatabaseAccounts_List |
|
Additional properties not allowed: enablePartitionKeyMonitor Source: response OperationId: DatabaseAccounts_List |
|
Additional properties not allowed: EnabledApiTypes Source: response OperationId: DatabaseAccounts_List |
|
Additional properties not allowed: configurationOverrides Source: response OperationId: DatabaseAccounts_List |
|
Additional properties not allowed: sqlEndpoint Source: response OperationId: DatabaseAccounts_ListByResourceGroup |
|
Additional properties not allowed: enablePartitionKeyMonitor Source: response OperationId: DatabaseAccounts_ListByResourceGroup |
|
Additional properties not allowed: EnabledApiTypes Source: response OperationId: DatabaseAccounts_ListByResourceGroup |
|
Additional properties not allowed: configurationOverrides Source: response OperationId: DatabaseAccounts_ListByResourceGroup |
|
Additional properties not allowed: sqlEndpoint Source: response OperationId: DatabaseAccounts_Get |
|
Additional properties not allowed: enablePartitionKeyMonitor Source: response OperationId: DatabaseAccounts_Get |
|
Additional properties not allowed: EnabledApiTypes Source: response OperationId: DatabaseAccounts_Get |
|
Additional properties not allowed: configurationOverrides Source: response OperationId: DatabaseAccounts_Get |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Missing required property: policyFormatVersion Url: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L10130:31 ExampleUrl: preview/2022-11-15-preview/examples/CosmosDBSqlContainerCreateUpdate.json#L9:43 |
|
Missing required property: policyFormatVersion Url: Microsoft.DocumentDB/preview/2022-11-15-preview/cosmos-db.json#L10130:31 ExampleUrl: preview/2022-11-15-preview/examples/CosmosDBSqlContainerCreateUpdate.json#L9:43 |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMReview
BreakingChangeReviewRequired
|
Hi @rsharm7, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
|
Hi, @rsharm7, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
|
Hi @rsharm7, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
@changlong-liu It seems like the avocado check is passing as well. If everything seems correct to you, could you please merge the PR? |
pjohari-ms
approved these changes
Feb 27, 2023
Hi @pjohari-ms , since the PR introduce new api version and has breaking change, we need ARM review and then breaking change review on this PR. |
AzureRestAPISpecReview
removed
the
BreakingChangeReviewRequired
|
@changlong-liu, following two apis are not supported. Need your sign-off on Avocado failures.
|
rsharm7
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
rsharm7
removed
the
DoNotMerge
pilor
added
ARMSignedOff
openapi-pipeline-app
bot
added
the
DoNotMerge
This was referenced Mar 2, 2023
11 tasks
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
* Adds base for updating Microsoft.DocumentDB from version preview/2022-08-15-preview to version 2022-11-15-preview * Updates readme * Updates API version in new specs and examples * Update cosmos-db.json * Update CosmosDBDatabaseAccountCreateMax.json * Update CosmosDBDatabaseAccountGet.json * Update CosmosDBDatabaseAccountList.json * Update CosmosDBDatabaseAccountPatch.json * Initial commit for SQL MV preview * swagger changes for x region restore * Update CosmosDBDatabaseAccountPatch.json * Update cosmos-db.json * Update cosmos-db.json * Update cosmos-db.json LRO_RESPONSE_HEADER * Update cosmos-db.json LRO_RESPONSE_HEADER * InAccountRestore changes * test case update * updated cosmos-db.json * prettifier fix * Revert "test case update" This reverts commit aec121f. * example test case update * Addressed PR comments * Addressed validation errors * Updated MV collection example * fixing invalid type * location & azure-AsyncOperation headers * prettified * add location and async in examples * fix location and async in service.json * fix invalid type * x-ms-identifiers to array * x-ms-identifiers to array * add RegionalServiceResource ref in locations * moved ServiceResourceProperties down * added all prop in ServiceResourceProperties * added endpoints in RegionalServiceResource * add name as identifier in location * fix TypeFormatChanged * revert changes in services * Reverted SQL MV changes * change type of additionalProperties * minimalTlsVersion * change in managedCassandra.json * remove extra tag * Revert "remove extra tag" This reverts commit 5ed208d. * Revert "Merge branch 'main' into cosmos-db-Microsoft.DocumentDB-2022-11-15-preview" This reverts commit 59691b7, reversing changes made to 407c5c9. * manually updated readme * Revert "manually updated readme" This reverts commit 86e67e1. * Revert "Revert "Merge branch 'main' into cosmos-db-Microsoft.DocumentDB-2022-11-15-preview"" This reverts commit 0c2f12a. * Revert "Revert "remove extra tag"" This reverts commit 3c97fe4. * Added suppressions * More suppressions * adding ResourceNameRestriction suppression path * Revert "adding ResourceNameRestriction suppression path" This reverts commit 728bbd9. * added tag to CosmosDBManagementClient * add CassandraClusters repair and nodeFetchStatus * RepairPostBody and ClusterNodeStatus in definition * added examples for newly added apis * Revert "added examples for newly added apis" This reverts commit 7178823. * Revert "RepairPostBody and ClusterNodeStatus in definition" This reverts commit 6b4f5f9. * Revert "add CassandraClusters repair and nodeFetchStatus" This reverts commit 0f17db1. * ClientEncryptionPolicy breaking change * RestoreParameters backward compatibility --------- Co-authored-by: Sarwesh Krishnan <skrishnan@microsoft.com> Co-authored-by: unknown <dsapaligaLocal@DESKTOP-6JU6P16.northamerica.corp.microsoft.com> Co-authored-by: Dinesh Kumar Dhamotharan <ddhamotharan@microsoft.com> Co-authored-by: ddhamotharan <105816437+ddhamotharan@users.noreply.github.com> Co-authored-by: dsapaliga <113381612+dsapaliga@users.noreply.github.com> Co-authored-by: pjohari-ms <84465928+pjohari-ms@users.noreply.github.com>
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.
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] 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. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.