[Cosmos DB] Microsoft.DocumentDB New API Version 2024-05-15-preview #28368
Conversation
…-02-15-preview to version 2024-05-15-preview
pjohari-ms
added
the
NotReadyForReview
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.8) | new version | base version |
|---|---|---|
| cosmos-db.json | 2024-05-15-preview(4e2ec21) | 2023-11-15(main) |
| cosmos-db.json | 2024-05-15-preview(4e2ec21) | 2024-02-15-preview(main) |
| dataTransferService.json | 2024-05-15-preview(4e2ec21) | 2024-02-15-preview(main) |
| managedCassandra.json | 2024-05-15-preview(4e2ec21) | 2023-11-15(main) |
| managedCassandra.json | 2024-05-15-preview(4e2ec21) | 2024-02-15-preview(main) |
| mongorbac.json | 2024-05-15-preview(4e2ec21) | 2023-11-15(main) |
| mongorbac.json | 2024-05-15-preview(4e2ec21) | 2024-02-15-preview(main) |
| notebook.json | 2024-05-15-preview(4e2ec21) | 2023-11-15(main) |
| notebook.json | 2024-05-15-preview(4e2ec21) | 2024-02-15-preview(main) |
| privateEndpointConnection.json | 2024-05-15-preview(4e2ec21) | 2023-11-15(main) |
| privateEndpointConnection.json | 2024-05-15-preview(4e2ec21) | 2024-02-15-preview(main) |
| privateLinkResources.json | 2024-05-15-preview(4e2ec21) | 2023-11-15(main) |
| privateLinkResources.json | 2024-05-15-preview(4e2ec21) | 2024-02-15-preview(main) |
| rbac.json | 2024-05-15-preview(4e2ec21) | 2023-11-15(main) |
| rbac.json | 2024-05-15-preview(4e2ec21) | 2024-02-15-preview(main) |
| restorable.json | 2024-05-15-preview(4e2ec21) | 2023-11-15(main) |
| restorable.json | 2024-05-15-preview(4e2ec21) | 2024-02-15-preview(main) |
| services.json | 2024-05-15-preview(4e2ec21) | 2023-11-15(main) |
| services.json | 2024-05-15-preview(4e2ec21) | 2024-02-15-preview(main) |
| throughputpool.json | 2024-05-15-preview(4e2ec21) | 2024-02-15-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 30 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️🔄LintDiff inProgress [Detail]
️❌Avocado: 7 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.DocumentDB/mongoClusters 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/2024-02-15-preview/mongoCluster.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/mongoClusters 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/2024-02-15-preview/mongoCluster.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/mongoClusters/{} 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/2024-02-15-preview/mongoCluster.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/mongoClusters/{}/firewallRules/{} 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/2024-02-15-preview/mongoCluster.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/mongoClusters/{}/firewallRules 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/2024-02-15-preview/mongoCluster.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.DocumentDB/locations/{}/checkMongoClusterNameAvailability 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/2024-02-15-preview/mongoCluster.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/mongoClusters/{}/listConnectionStrings 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/2024-02-15-preview/mongoCluster.json |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMChangesRequested
|
Please address or respond to feedback from the ARM API reviewer. |
Co-authored-by: Andrew Khoma <[email protected]>
microsoft-github-policy-service
bot
added
no-recent-activity
* swagger changes for capacityMode changes * Ran the npx Prettier command * fixing swagger lint * fixing camelcase issue
* NSP RP API changes * small change * validation failures handling * linter errors * types version * still failing * Probably all the fixes * Missed one file * Will revert this commit - temp fix for hanging push * Reverted commit --------- Co-authored-by: pjohari-ms <[email protected]>
...oft.DocumentDB/preview/2024-05-15-preview/examples/CosmosDBManagedCassandraCommandAsync.json
Show resolved
Hide resolved
...ft.DocumentDB/preview/2024-05-15-preview/examples/CosmosDBManagedCassandraCommandResult.json
Show resolved
Hide resolved
...ocumentDB/preview/2024-05-15-preview/examples/CosmosDBManagedCassandraCommandResultList.json
Outdated
Show resolved
Hide resolved
|
@vandit15 @pjohari-ms I'm working on adding NetworkSecurityPerimeters to common types, as something like this is clearly urgently needed! |
TimLovellSmith
added
ARMSignedOff
|
I have a lingering worry that some of the avocado errors might matter (e.g. missing a link to an example could stop it showing in docs, or perhaps impact model validation), have you looked into fixing them? Unfortunately some tools struggle to understand circular references, you can try normalizing them to a noncircular structure by moving definitions between jsons -- or by refactoring using common-types version of privatelinks.json if its sufficiently compatible. (Did we already reject that option? Too many PRs to remember them all properly, sorry!) ❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file. |
konrad-jamrozik
added
ARMChangesRequested
There was a problem hiding this comment.
Using github to add a TODO here -
Independent of ARM API review and manifest rollout:
Please let us update this PR to use the common types definition for networkSecurityPerimeter.json here #28958 (PR will be merged asap)
before actually merging.
* Review comments - Cassandra and circular reference * Nits - Services.json * Porting from stable brranch * Nits * Moved files
pjohari-ms
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
ACK. Will wait for the PR to be edited by the maintainers before merging. |
These are fixed. MISSING_APIS ones are expected. |
|
All comments other than the incorrect api-version in examples are addressed. |
madhura-np
added
ARMSignedOff
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
konrad-jamrozik
removed
the
DoNotMerge
|
Merge without branch refresh should be OK per comment in API Spec Review team here: https://teams.microsoft.com/l/message/19:[email protected]/1715629299216?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&parentMessageId=1715624451175&teamName=Azure%20SDK&channelName=API%20Spec%20Review&createdTime=1715629299216. However, merge is currently blocked by @TimLovellSmith pending review comments. Tim, please approve or comment. |
|
@TimLovellSmith Can this be merged? The PR merge is being delayed and we have to work for achieving BUILD timelines. |
|
@pjohari-ms update, hopefully this is unblocked for refactor real soon. The adding NSP common-types PR should be merge-ready now, it should just need the checks to come back alive and tell us if its all clear to merge. |
|
@pjohari-ms finally NSP common types is merged: #28958 - please can you update your PRs with NSPs to use common types or let me know any remaining blocker. |
|
Created a new PR to handle the ongoing issues in this one - #29192 |
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.Note
As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1, Breaking Changes review
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.