-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Peering api 2021-06-01 #14703
Peering api 2021-06-01 #14703
Conversation
Hi, @renuka-raju 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
|
Rule | Message |
---|---|
R4009 - RequiredReadOnlySystemData |
The response of operation:'ConnectionMonitorTests_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Peering/stable/2021-06-01/peering.json#L1404 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ConnectionMonitorTests_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Peering/stable/2021-06-01/peering.json#L1459 |
OperationId should contain the verb: 'lookingglass' in:'LookingGlass_Invoke'. Consider updating the operationId Location: Microsoft.Peering/stable/2021-06-01/peering.json#L185 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isTestSuccessful Location: Microsoft.Peering/stable/2021-06-01/peering.json#L3591 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4009 - RequiredReadOnlySystemData |
The response of operation:'PeerAsns_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Peering/stable/2021-06-01/peering.json#L289 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'RegisteredAsns_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Peering/stable/2021-06-01/peering.json#L537 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'RegisteredPrefixes_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Peering/stable/2021-06-01/peering.json#L772 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Peerings_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Peering/stable/2021-06-01/peering.json#L1007 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Prefixes_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Peering/stable/2021-06-01/peering.json#L1724 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'PeeringServices_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Peering/stable/2021-06-01/peering.json#L2012 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'PeerAsns_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Peering/stable/2021-06-01/peering.json#L330 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'RegisteredAsns_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Peering/stable/2021-06-01/peering.json#L592 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'RegisteredPrefixes_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Peering/stable/2021-06-01/peering.json#L827 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Peerings_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Peering/stable/2021-06-01/peering.json#L1055 |
️️✔️
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: 12 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.11)
- current:stable/2021-06-01/peering.json compared with base:stable/2021-01-01/peering.json
- current:stable/2021-06-01/peering.json compared with base:preview/2020-01-01-preview/peering.json
The following breaking changes are detected by comparison with latest preview version:
️️✔️
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":"peering/resource-manager/readme.md",
"tag":"package-2021-06-01",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"peering/resource-manager/readme.md",
"tag":"package-2021-06-01",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"peering/resource-manager/readme.md",
"tag":"package-2021-06-01",
"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).
Swagger Generation Artifacts
|
Hi, @renuka-raju your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @ |
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. |
Thanks for copying older version in the first commit, It helped me review the changes efficiently. I reviewed the changes. Changes looks good, marking ARM_Signedoff. |
Approving for changes in |
There is few Linter error about system data. do you have plan to support system data? and removing a path(CheckServiceProviderAvailability) from previous stable version is a breaking change which need breaking change review board approval, it is on purpose? |
Hi @renuka-raju, 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. |
Hi @akning-ms , thanks for your review, the CheckServiceProviderAvailability was changed back so it is not a breaking change. We do not plan to support systemData for this API version, but we will plan for future API. @renuka-raju will reply with justification for the other breaking changes. |
6223d11
to
1f145a5
Compare
Correction: path CheckServiceProviderAvailability rename to checkServiceProviderAvailability is required, as it is s360 linting violation |
Hi @akning-ms , for each breaking change here are the relevant s360 items: |
* Existing version in new directory * 2021-06-01 swagger correctness changes * Resolved conflict * [feat] Add looking glass documentation to 2021-06-01 * [fix] Change LookingGlasses to LookingGlass * Add connection monitor models and examples * Remove LookingGlass response status codes and fix parameter capitalization * Fix ReadOnly properties in request * Remove last readOnly property Co-authored-by: Renuka Raju <[email protected]> Co-authored-by: Jimmy Xu <[email protected]> Co-authored-by: Slava Uryumtsev <[email protected]>
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.