-
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
Added GA API version (2021-07-01) #14937
Added GA API version (2021-07-01) #14937
Conversation
…ResourceGroupName - Adds default value for publicNetworkAccess property. - Adds "x-ms-mutability" attribute for managedResourceGroupName property.
Hi, @shaileshsk94 Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
Swagger Generation Artifacts
|
Hi, @shaileshsk94 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
NewApiVersionRequired reason: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes in readme.go.md
LGTM
Hi @shaileshsk94, 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. |
@shaileshsk94 looks like you're updating an old API version with a new path. For that, you need to get approval from Breaking Changes Review board (which is different than ARM API Review Board). The instructions for that is pasted by the openapi bot above. |
Swagger Validation Report
|
Rule | Message |
---|---|
1044 - XmsLongRunningOperationChanged |
The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L671:7 Old: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L671:7 |
️⚠️
LintDiff: 0 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4009 - RequiredReadOnlySystemData |
The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Purview/stable/2021-07-01/purview.json#L672 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'PrivateEndpointConnections_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Purview/stable/2021-07-01/purview.json#L720 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Accounts_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L117 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L623 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Accounts_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L158 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'PrivateEndpointConnections_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L671 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Accounts_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L260 |
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Purview/stable/2021-07-01/purview.json#L1409 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Purview/stable/2021-07-01/purview.json#L1759 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L1369 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross-Version Breaking Changes: 2 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.11)
- current:stable/2021-07-01/purview.json compared with base:preview/2020-12-01-preview/purview.json
Rule | Message |
---|---|
1033 - RemovedProperty |
The new version is missing a property found in the old version. Was 'systemData' renamed or removed? New: Microsoft.Purview/stable/2021-07-01/purview.json#L1052:7 Old: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L1002:7 |
1044 - XmsLongRunningOperationChanged |
The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Purview/stable/2021-07-01/purview.json#L720:7 Old: Microsoft.Purview/preview/2020-12-01-preview/purview.json#L671:7 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"purview/resource-manager/readme.md",
"tag":"package-2020-12-01-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"purview/resource-manager/readme.md",
"tag":"package-2020-12-01-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"purview/resource-manager/readme.md",
"tag":"package-2021-07-01",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"purview/resource-manager/readme.md",
"tag":"package-2021-07-01",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"purview/resource-manager/readme.md",
"tag":"package-2020-12-01-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/purview.json
Show resolved
Hide resolved
specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/purview.json
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@pilor
we don't use OpenApi for swagger generation as of now (as we are on older version of .net core 2.1). We generate swagger using legacy and systemData is not present in the acceptable list of top level properties.
For POST rootCollectionAdmin API,
this is one off API supported for data plane lockout mitigation scenario.
So, we don't expose APIs to list or remove root collection admin.
Root collection is a data plane concept specifically for Azure Purview.
Thus, it will not impact ability to create account (partial config etc) via template.
specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/purview.json
Show resolved
Hide resolved
@ArcturusZhang could you approve go SDK breaking change ? |
…#15245) This reverts commit 654c237. Co-authored-by: Shailesh Kelkar <[email protected]>
* Fixed swagger validation warnings for publicNetworkAccess and managedResourceGroupName - Adds default value for publicNetworkAccess property. - Adds "x-ms-mutability" attribute for managedResourceGroupName property. * Ran prettier check to fix warnings * Added GA api-version (2021-07-01) * Addressed typo * Removed AddRootCollectionAdmin API from preview version * Updated private endpoint connection approval operation as a long running operation * Fixed swagger breaking changes for long running operation * Updated long running operation for preview api-version * removed vscode settings json changes * Updated systemData and added Canceled provisioning state * Updated Go SDK output folder path Co-authored-by: Shailesh Kelkar <[email protected]>
This reverts commit d1bf50c.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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 Breaking Change Review Board as defined in the Breaking Change Policy.
Action: 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.