-
Notifications
You must be signed in to change notification settings - Fork 5.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
MongoCluster Microsoft.DocumentDb 2024-06-01-preview #29330
Merged
olivertowers
merged 43 commits into
main
from
olivertowers-mongocluster-Microsoft.DocumentDB-2024-06-01-preview
Aug 7, 2024
Merged
MongoCluster Microsoft.DocumentDb 2024-06-01-preview #29330
olivertowers
merged 43 commits into
main
from
olivertowers-mongocluster-Microsoft.DocumentDB-2024-06-01-preview
Aug 7, 2024
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
…DB-2026-06-01-preview
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.12) | new version | base version |
---|---|---|
mongoCluster.json | 2024-06-01-preview(1d58eb6) | 2024-03-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
The '$ref' property points to different models in the old and new versions. New: Microsoft.DocumentDB/preview/2024-06-01-preview/mongoCluster.json#L1569:9 Old: Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json#L1368:9 |
|
The new version has a different format 'arm-id' than the previous one ''. New: Microsoft.DocumentDB/preview/2024-06-01-preview/mongoCluster.json#L1569:9 Old: Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json#L1368:9 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
Compared specs (v2.2.2) | new version | base version |
---|---|---|
package-2024-06-01-preview | package-2024-06-01-preview(1d58eb6) | default(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-06-01-preview/mongoCluster.json#L613 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/preview/2024-06-01-preview/mongoCluster.json#L928 |
OperationId should contain the verb: 'checkmongoclusternameavailability' in:'MongoClusters_CheckNameAvailability'. Consider updating the operationId Location: Microsoft.DocumentDB/preview/2024-06-01-preview/mongoCluster.json#L100 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DocumentDB/preview/2024-06-01-preview/mongoCluster.json#L1707 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DocumentDB/preview/2024-06-01-preview/mongoCluster.json#L1726 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
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
|
olivertowers
added
the
DoNotMerge
<valid label in PR review process> use to hold merge after approval
label
Jun 4, 2024
AzureRestAPISpecReview
added
ARMReview
new-api-version
resource-manager
TypeSpec
Authored with TypeSpec
WaitForARMFeedback
<valid label in PR review process> add this label when ARM review is required
labels
Jun 4, 2024
This was referenced Jun 4, 2024
AzureRestAPISpecReview
added
the
ReadyForApiTest
<valid label in PR review process>add this label when swagger and service APIs are ready for test
label
Jun 5, 2024
…DB-2024-06-01-preview
…01-preview' of https://github.com/Azure/azure-rest-api-specs into olivertowers-mongocluster-Microsoft.DocumentDB-2024-06-01-preview
Approved BreakingChange-Go-Sdk-Approved is expected, caused by typespec-go emit option |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
rkmanda
approved these changes
Aug 6, 2024
…DB-2024-06-01-preview
olivertowers
added
the
PublishToCustomers
Acknowledgement the changes will be published to Azure customers.
label
Aug 6, 2024
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
…DB-2024-06-01-preview
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
…DB-2024-06-01-preview
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
/pr RequestMerge |
olivertowers
deleted the
olivertowers-mongocluster-Microsoft.DocumentDB-2024-06-01-preview
branch
August 7, 2024 14:46
dhananjay824
pushed a commit
to dhananjay824/azure-rest-api-specs
that referenced
this pull request
Aug 9, 2024
* Initial 2024-06-01-preview changes * Match breaking change fixes * remove redundant file * Compile changes * style/linter fixes * Add replica promotion and geo-replica scenario * Linter/style fixes * Fixes * Fix: Spellcheck, ModelValidation, Advocado * Fix promote async action, fix promote example, add reset password example. * Add examples * Fix examples * Fix more examples * prettier fixes * Fix LintDiff warnings * Fixes * Fix example * Update npm and redo tsv * Changes * address comments * update scenario file * Finalize basic scenario * Add suppression for Azure/azure-openapi-validator#722 * Fix supression * Fix typespec validations * Override go SDK for MongoClusterStatus * Convert to new AutoRest suppressions format. * Update readme.md --------- Co-authored-by: Roopesh Manda <rmanda@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Approved-Suppression
ARMReview
ARMSignedOff
<valid label in PR review process>add this label when ARM approve updates after review
BreakingChange-Go-Sdk
BreakingChange-Go-Sdk-Approved
new-api-version
PipelineBotTrigger
PublishToCustomers
Acknowledgement the changes will be published to Azure customers.
ReadyForApiTest
<valid label in PR review process>add this label when swagger and service APIs are ready for test
resource-manager
SuppressionReviewRequired
TypeSpec
Authored with TypeSpec
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 help
section 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 ApiView
comment 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 PR
andDue diligence checklist
.write access
per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext Steps to Merge
comment. 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.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.