-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Nits - Services.json #29020
Merged
pjohari-ms
merged 2 commits into
Azure:release-cosmos-db-Microsoft.DocumentDB-2024-05-15
from
pjohari-ms:stable_nits_0507
May 8, 2024
Merged
Nits - Services.json #29020
pjohari-ms
merged 2 commits into
Azure:release-cosmos-db-Microsoft.DocumentDB-2024-05-15
from
pjohari-ms:stable_nits_0507
May 8, 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
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
Compared specs (v0.10.8) | new version | base version |
---|---|---|
services.json | 2024-05-15(aaee29e) | 2023-11-15(main) |
services.json | 2024-05-15(aaee29e) | 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:
️⚠️
LintDiff: 0 Warnings warning [Detail]
Compared specs (v2.2.2) | new version | base version |
---|---|---|
package-2024-05 | package-2024-05(aaee29e) | 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 |
---|---|
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L63 |
ResourceNameRestriction |
The resource name parameter 'serviceName' should be defined with a 'pattern' restriction. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L79 |
ProvisioningStateSpecifiedForLROPut |
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L80 |
ProvisioningStateSpecifiedForLROPut |
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L80 |
PutRequestResponseSchemeArm |
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Service_Create' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L80 |
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/stable/2024-05-15/services.json#L80 |
LroErrorContent |
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/services.json#L153 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L213 |
LroErrorContent |
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/services.json#L277 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L285 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L359 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L371 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L383 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L394 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L450 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L461 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L487 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L498 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L531 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L542 |
A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L37 |
|
Use the latest version v5 of types.json. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L48 |
|
Use the latest version v5 of types.json. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L51 |
|
Use the latest version v5 of types.json. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L57 |
|
Use the latest version v5 of types.json. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L106 |
|
Use the latest version v5 of types.json. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L109 |
|
Use the latest version v5 of types.json. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L118 |
|
Use the latest version v5 of types.json. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L183 |
|
Use the latest version v5 of types.json. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L186 |
|
Use the latest version v5 of types.json. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L195 |
️️✔️
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
|
… stable_nits_0507
AzureRestAPISpecReview
added
ARMReview
resource-manager
WaitForARMFeedback
<valid label in PR review process> add this label when ARM review is required
labels
May 8, 2024
This was referenced May 8, 2024
Closed
chandugunturi
approved these changes
May 8, 2024
pjohari-ms
merged commit May 8, 2024
90ee870
into
Azure:release-cosmos-db-Microsoft.DocumentDB-2024-05-15
24 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
Labels
ARMReview
BreakingChange-Go-Sdk
resource-manager
WaitForARMFeedback
<valid label in PR review process> add this label when ARM review is required
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
.Next 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.