Nits - review comments #28957
Merged
Nits - review comments #28957
Conversation
This file contains hidden or 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
|
PR validation pipeline restarted successfully. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
Swagger Validation Report
|
| Compared specs (v0.10.8) | new version | base version |
|---|---|---|
| managedCassandra.json | 2024-05-15(d89e28b) | 2023-11-15(main) |
| managedCassandra.json | 2024-05-15(d89e28b) | 2024-02-15-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️⚠️LintDiff: 0 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2024-05 | package-2024-05(d89e28b) | package-2024-05(release-cosmos-db-Microsoft.DocumentDB-2024-05-15) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
provisioningState property must be set to readOnly. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L138 |
|
A 202 response should include an Location response header. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L174 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L183 |
|
provisioningState property must be set to readOnly. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L223 |
|
provisioningState property must be set to readOnly. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L229 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L236 |
|
Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L263 |
|
Mark the property 'properties.provisioningState', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L263 |
|
Properties of a PATCH request body must not be x-ms-mutability: ['create'], property:restoreFromBackupId. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L267 |
|
Properties of a PATCH request body must not be x-ms-mutability: ['create'], property:initialCassandraAdminPassword. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L267 |
|
A 202 response should include an Location response header. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L274 |
|
provisioningState property must be set to readOnly. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L276 |
|
provisioningState property must be set to readOnly. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L282 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L289 |
|
202 response for a LRO POST operation must not have a response schema specified. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L296 |
|
A 202 response should include an Location response header. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L329 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L338 |
|
provisioningState property must be set to readOnly. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L415 |
|
A 202 response should include an Location response header. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L454 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L463 |
|
provisioningState property must be set to readOnly. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L506 |
|
provisioningState property must be set to readOnly. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L512 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L519 |
|
Mark the property 'properties.provisioningState', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L549 |
|
A 202 response should include an Location response header. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L560 |
|
provisioningState property must be set to readOnly. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L562 |
|
provisioningState property must be set to readOnly. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L568 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L575 |
|
A 202 response should include an Location response header. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L606 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json#L612 |
️️✔️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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMReview
resource-manager
SuppressionReviewRequired
WaitForARMFeedback
This was referenced May 2, 2024
Closed
vandit15
approved these changes
May 3, 2024
chandugunturi
approved these changes
May 3, 2024
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
pjohari-ms
merged commit cc536cb
into
Azure:release-cosmos-db-Microsoft.DocumentDB-2024-05-15
25 of 29 checks passed
mentat9
pushed a commit
that referenced
this pull request
May 16, 2024
* Adds base for updating Microsoft.DocumentDB from version stable/2023-11-15 to version 2024-05-15 * Updates readme * Updates API version in new specs and examples * Add mongo v5 and v6 to the swagger (#28473) Co-authored-by: Andrew Khoma <[email protected]> * [CosmosDB-MICassandra] Added VPN feature properties to stable (#28540) * Added VPN feature properties * Fixed SpellCheck violation and added arm-id format to privateLinkResourceId * Added arm-id-details to privateLinkResourceId --------- Co-authored-by: drewkaufmann <[email protected]> * SqlDedicatedGateway DistributedQuery stable changes (#28747) * Distributed Query changes * Nits * Fixed model validation * More fixes * Nits - review comments (#28957) * Nits - Services.json (#29020) * add sdk-suppressions.yaml (#29077) --------- Co-authored-by: Andrew Khoma <[email protected]> Co-authored-by: Andrew Khoma <[email protected]> Co-authored-by: Guanzhou Song <[email protected]> Co-authored-by: drewkaufmann <[email protected]> Co-authored-by: Peng Jiahui <[email protected]>
Francisco-Gamino
pushed a commit
to Francisco-Gamino/azure-rest-api-specs
that referenced
this pull request
Jun 5, 2024
) * Adds base for updating Microsoft.DocumentDB from version stable/2023-11-15 to version 2024-05-15 * Updates readme * Updates API version in new specs and examples * Add mongo v5 and v6 to the swagger (Azure#28473) Co-authored-by: Andrew Khoma <[email protected]> * [CosmosDB-MICassandra] Added VPN feature properties to stable (Azure#28540) * Added VPN feature properties * Fixed SpellCheck violation and added arm-id format to privateLinkResourceId * Added arm-id-details to privateLinkResourceId --------- Co-authored-by: drewkaufmann <[email protected]> * SqlDedicatedGateway DistributedQuery stable changes (Azure#28747) * Distributed Query changes * Nits * Fixed model validation * More fixes * Nits - review comments (Azure#28957) * Nits - Services.json (Azure#29020) * add sdk-suppressions.yaml (Azure#29077) --------- Co-authored-by: Andrew Khoma <[email protected]> Co-authored-by: Andrew Khoma <[email protected]> Co-authored-by: Guanzhou Song <[email protected]> Co-authored-by: drewkaufmann <[email protected]> Co-authored-by: Peng Jiahui <[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.
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.