-
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
[Hub Generated] Publish private branch 'jelautma/Replace-2021-10-01-preview-with-2022-07-01-preview' #19648
Conversation
The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/7651 |
Hi, @jlautman 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. vscswagger@microsoft.com |
Swagger Validation Report
|
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-preview-2022-07 | package-preview-2022-07(8e74d69) | default(main) |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
API Readiness check failed. Please make sure your service is deployed. |
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.Communication' for api version '2022-07-01-preview'. The supported api-versions are '2020-08-20-preview, 2020-08-20, 2021-10-01-preview'." |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️
SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
"readme":"communication/resource-manager/readme.md", "tag":"package-preview-2022-07", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > Resource > properties > systemData)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
💬 | "readme":"communication/resource-manager/readme.md", "tag":"package-preview-2022-07", "details":"AutoRest core version selected from configuration: ^3.2.0." |
💬 | "readme":"communication/resource-manager/readme.md", "tag":"package-preview-2022-07", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)" |
💬 | "readme":"communication/resource-manager/readme.md", "tag":"package-preview-2022-07", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)" |
💬 | "readme":"communication/resource-manager/readme.md", "tag":"package-preview-2022-07", "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)" |
💬 | "readme":"communication/resource-manager/readme.md", "tag":"package-preview-2022-07", "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)" |
💬 | "readme":"communication/resource-manager/readme.md", "tag":"package-preview-2022-07", "details":"Autorest completed in 9.77s. 0 files generated." |
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
Hi @jlautman, Your PR has some issues. Please fix the CI sequentially by following the order of
|
8349089
to
8e74d69
Compare
@akning-ms Please assist with failing checks. There is an operations type in the new api version (In CommunicationServices.json) and the breaking changes are just because those definitions were replaced by the common-types TrackedResource. |
For Policy check failure, @tianxchen-ms to take a look |
Our deployment order has to be code support -> swagger change -> ARM manifest change because we use RPaaS. RPaaS manages our ARM manifest and they check that the swagger is available before they'll generate the manifest supporting it. Please coordinate with the RPaaS team about the api readiness check since this will apply for all 80+ RPs using RPaaS. We're planning to release the API version as soon as this is merged and we can start an ARM manifest rollout. |
The RPaaS team recommended that we revert changing to sdk tag property in readme.md to package-2021-10-01-preview for the purpose of this check-in, use that to deploy the RPaaS configuration (and therefore the ARM manifest), and then change the sdk tag property to reference 2022-07-01-preview in a follow-on PR. Would that resolve the ApiReadinessCheck? |
/azp run unifiedPipeline |
No pipelines are associated with this pull request. |
Hi @jlautman, You don't need to change readme tag bypass it. if you are only wait for manifest to enable this version in production. once policy check is pass, I will help you merge this PR |
@akning-ms can we merge then? The two failures are a false positive from dotnet sdk and the api readiness check we discussed above. |
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.