[CosmosDB] Fixing gaps in the new apiVersion #11609
Closed
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
Merge master
Merge master
Merge master
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version has a new property 'description' in response that was not found in the old version. New: Microsoft.DocumentDB/stable/2020-09-01/privateEndpointConnection.json#L295:7 Old: Microsoft.DocumentDB/stable/2020-09-01/cosmos-db.json#L7777:7 |
|
The new version has a new property 'groupId' in response that was not found in the old version. New: Microsoft.DocumentDB/stable/2020-09-01/privateEndpointConnection.json#L263:7 Old: Microsoft.DocumentDB/stable/2020-09-01/cosmos-db.json#L7753:7 |
|
The new version has a new property 'provisioningState' in response that was not found in the old version. New: Microsoft.DocumentDB/stable/2020-09-01/privateEndpointConnection.json#L263:7 Old: Microsoft.DocumentDB/stable/2020-09-01/cosmos-db.json#L7753:7 |
️❌LintDiff: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"details":" "Channel": "fatal", "Text": "swagger-document/compose - FAILED" "Channel": "fatal", "Text": "Error: '$.definitions.ErrorResponse.properties.code.description' has incompatible values (---\nError code.\n, ---\nThe error code.\n)."(node:6369) UnhandledPromiseRejectionWarning: Error: '$.definitions.ErrorResponse.properties.code.description' has incompatible values (---Error code.", "location":"https://github.com/Azure/azure-rest-api-specs/blob/717a27f9e920ef4e3def20fc15694d6278bfcd25/specification/cosmos-db/resource-manager/readme.md" |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The JSON file has a circular reference. readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/stable/2020-09-01/privateEndpointConnection.json |
️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Following response status codes "200" for operation "PrivateEndpointConnections_Delete" were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️[Staging] Cross Version BreakingChange (Base on preview version): 9 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.8.1)
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
Swagger Generation Artifacts
|
|
Azure Pipelines successfully started running 1 pipeline(s). |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @MehaKaushik your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @ArcturusZhang |
ChenTanyi
reviewed
Nov 10, 2020
...os-db/resource-manager/Microsoft.DocumentDB/stable/2020-09-01/privateEndpointConnection.json
Show resolved
Hide resolved
azure-sdk-for-go
|
Azure CLI Extension Generation
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-java
|
azure-sdk-for-js
|
azure-sdk-for-net
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-python
- Breaking Change detected in SDK
|
azure-sdk-for-python-track2
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-resource-manager-schemas
|
Trenton Generation
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
This was referenced Nov 10, 2020
This was referenced Nov 17, 2020
ArcturusZhang
approved these changes
Nov 17, 2020
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
added 3 commits
November 17, 2020 16:45
|
Hi @MehaKaushik please resolve the CI failures.
|
|
Hi @ArcturusZhang regarding these breaking changes here(https://github.com/Azure/azure-rest-api-specs/pull/11609/checks?check_run_id=1420566034) In apiVersion 2020-04-01 privateEndpointConnextion.json and privateLinkResources.json files were referenced from the preview apiVersion 2019-08-01-preview. When we created 2020-09-01 swagger specs we used OpenAPIHub to copy the 2020-04-01 specs. This resulted in the copying of privateEndpoint related properties. Now, in this PR I am adding the JSON files by copying them from 2019-08-01. I would have expected the property definitions to look exactly the same but there are few differences. The correct definitions are the ones that I am introducing in this PR. Can we get a breaking change exception? |
I removed the redundant ErroResponse, yet this error is still showing up. Can you help identify the root cause. |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
majastrz
added
ARMSignedOff
|
You are modifying an existing stable API version, which is considered a breaking change. (See https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#versioning for details.) You should either request a breaking change approval (instructions in the link) or introduce this functionality in a new API version. |
|
Hi @MehaKaushik, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
majastrz
removed
the
WaitForARMFeedback
|
Because of the breaking changes, I am abandoning this PR. We will add GA PrivateEndpoint APIs in the next apiVersion. |
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.
This PR moves privateEndpoint related specs from preview API to latest stable API. This is done because the feature is GA'ed since March and we wanted to make the specs available consistently.
This PR also edits readmes to incorporate the new apiVersion.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.
To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.