[Microsoft.DocumentDB] CosmosDB - New API Version - 2024-05-15-preview #29192
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
Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from preview/2024-02-15-preview to preview/2024-05-15-preview.
Co-authored-by: Andrew Khoma <[email protected]>
* 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]>
* Review comments - Cassandra and circular reference * Nits - Services.json * Porting from stable brranch * Nits * Moved files
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(53589e1) | 2024-05-15(main) |
| cosmos-db.json | 2024-05-15-preview(53589e1) | 2024-02-15-preview(main) |
| dataTransferService.json | 2024-05-15-preview(53589e1) | 2024-02-15-preview(main) |
| managedCassandra.json | 2024-05-15-preview(53589e1) | 2024-05-15(main) |
| managedCassandra.json | 2024-05-15-preview(53589e1) | 2024-02-15-preview(main) |
| mongorbac.json | 2024-05-15-preview(53589e1) | 2024-05-15(main) |
| mongorbac.json | 2024-05-15-preview(53589e1) | 2024-02-15-preview(main) |
| notebook.json | 2024-05-15-preview(53589e1) | 2024-05-15(main) |
| notebook.json | 2024-05-15-preview(53589e1) | 2024-02-15-preview(main) |
| privateEndpointConnection.json | 2024-05-15-preview(53589e1) | 2024-05-15(main) |
| privateEndpointConnection.json | 2024-05-15-preview(53589e1) | 2024-02-15-preview(main) |
| privateLinkResources.json | 2024-05-15-preview(53589e1) | 2024-05-15(main) |
| privateLinkResources.json | 2024-05-15-preview(53589e1) | 2024-02-15-preview(main) |
| rbac.json | 2024-05-15-preview(53589e1) | 2024-05-15(main) |
| rbac.json | 2024-05-15-preview(53589e1) | 2024-02-15-preview(main) |
| restorable.json | 2024-05-15-preview(53589e1) | 2024-05-15(main) |
| restorable.json | 2024-05-15-preview(53589e1) | 2024-02-15-preview(main) |
| services.json | 2024-05-15-preview(53589e1) | 2024-05-15(main) |
| services.json | 2024-05-15-preview(53589e1) | 2024-02-15-preview(main) |
| throughputpool.json | 2024-05-15-preview(53589e1) | 2024-02-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:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️🔄LintDiff inProgress [Detail]
️❌Avocado: 9 Errors, 0 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 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
ARMReview
BreakingChangeReviewRequired
This was referenced May 21, 2024
This was referenced May 21, 2024
TimLovellSmith
added
BreakingChange-Approved-UserImpact
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
|
@pjohari-ms Fix the PrettierCheck so I can merge it |
@razvanbadea-msft Prettier check is somehow reporting issues from previous versions/existing changes - there are 260 errors right now and all of them because of changes in code that were not made in this PR. As discussed in the email chain and as @TimLovellSmith pointed out, this seems to be an issue with how previous issues are being calculated. |
|
@razvanbadea-msft I ran prettier anyway. Please merge the PR. |
razvanbadea-msft
approved these changes
May 22, 2024
7 tasks
Francisco-Gamino
pushed a commit
to Francisco-Gamino/azure-rest-api-specs
that referenced
this pull request
Jun 5, 2024
Azure#29192) * Copy files from preview/2024-02-15-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-05-15-preview Updated the API version from preview/2024-02-15-preview to preview/2024-05-15-preview. * Added tag for 2024-05-15-preview in readme file * Add mongo v5 and v6 to the preview swagger (Azure#28472) Co-authored-by: Andrew Khoma <[email protected]> * swagger changes for capacityMode changes (Azure#28457) * swagger changes for capacityMode changes * Ran the npx Prettier command * fixing swagger lint * fixing camelcase issue * NSP RP changes for public preview (Azure#28552) * 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]> * Remove mongoCluster swagger spec and examples for 2024-05-15-preview release (Azure#28693) * Porting from stable changes from Cassandra API (Azure#28801) * nsp related comments (Azure#28950) * Review comments - Cassandra and circular reference (Azure#29021) * Review comments - Cassandra and circular reference * Nits - Services.json * Porting from stable brranch * Nits * Moved files * Using common types * Fixes * Used custom parameter - as suggested by reviewer * Merged commit correctly * Another merge remove issue * Prettier issues due to line endings being different during merge * Prettier check. Whole folder. --------- Co-authored-by: Andrew Khoma <[email protected]> Co-authored-by: Andrew Khoma <[email protected]> Co-authored-by: chandrasekhar gunturi <[email protected]> Co-authored-by: Vandit Jain <[email protected]> Co-authored-by: Oliver Towers <[email protected]>
8 tasks
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 (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
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.