-
Notifications
You must be signed in to change notification settings - Fork 5.6k
[Microsoft.DocumentDB] Bug fix for stable API Version 2024-05-15 #29346
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
Merged
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
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.9) | new version | base version |
|---|---|---|
| services.json | 2024-05-15(678ee5f) | 2024-05-15(main) |
| Rule | Message |
|---|---|
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'DataTransferServiceResourceCreateUpdateParameters' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L284:3 Old: Microsoft.DocumentDB/stable/2024-05-15/services.json#L284:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'SqlDedicatedGatewayServiceResourceCreateUpdateParameters' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L284:3 Old: Microsoft.DocumentDB/stable/2024-05-15/services.json#L284:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'GraphAPIComputeServiceResourceCreateUpdateParameters' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L284:3 Old: Microsoft.DocumentDB/stable/2024-05-15/services.json#L284:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'MaterializedViewsBuilderServiceResourceCreateUpdateParameters' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/services.json#L284:3 Old: Microsoft.DocumentDB/stable/2024-05-15/services.json#L284:3 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️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-05 | package-2024-05(678ee5f) | package-2024-05(main) |
The following errors/warnings exist before current PR submission:
| 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 |
| 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 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L239 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L242 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L251 |
|
| Missing identifier id in array item property Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L398 |
|
| Missing identifier id in array item property Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L472 |
|
| Missing identifier id in array item property Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L506 |
|
| Missing identifier id in array item property Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L546 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.DocumentDB/stable/2024-05-15/services.json#L576 |
️️✔️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
|
This was referenced Jun 5, 2024
Member
Author
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
This reverts commit 03a9987.
rkmanda
approved these changes
Jun 7, 2024
rkmanda
approved these changes
Jun 7, 2024
rkmanda
approved these changes
Jun 9, 2024
Member
|
The PR is at step 3 of the PR workflow. Please wait for the SDK breaking change approval before requesting merge again. |
Member
Member
Author
|
/pr RequestMerge |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
ARMReview
ARMSignedOff
<valid label in PR review process>add this label when ARM approve updates after review
BreakingChange-Approved-BugFix
Changes are to correct the REST API definition to correctly describe service behavior
BreakingChange-JavaScript-Sdk
BreakingChange-JavaScript-Sdk-Approved
BreakingChange-Python-Sdk
BreakingChange-Python-Sdk-Approved
BreakingChangeReviewRequired
<valid label in PR review process>add this label when breaking change review is required
ReadyForApiTest
<valid label in PR review process>add this label when swagger and service APIs are ready for test
resource-manager
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.write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext 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.