Azure EventGrid 2023-06-01-preview: Management Swagger and Examples #23981
Conversation
…eview requirement
… related examples for API Version: 2023-06-01-preview
|
Hi, @ahamad-MS 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 swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| EventGrid.json | 2023-06-01-preview(224cda0) | 2022-06-15(main) |
| EventGrid.json | 2023-06-01-preview(224cda0) | 2021-10-15-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️🔄LintDiff inProgress [Detail]
️❌Avocado: 3 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.EventGrid/partnerNamespaces/{}/eventChannels/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/eventgrid/resource-manager/readme.md json: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.EventGrid/partnerNamespaces/{}/eventChannels is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/eventgrid/resource-manager/readme.md json: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json |
|
The default tag should contain all APIs. The API path /providers/Microsoft.EventGrid/partnerRegistrations is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/eventgrid/resource-manager/readme.md json: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json |
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.EventGrid' for api version '2023-06-01-preview'. The supported api-versions are '2017-06-15-preview, 2017-09-15-preview, 2018-01-01, 2018-05-01-preview, 2018-09-15-preview, 2019-01-01, 2019-02-01-preview, 2019-06-01, 2020-01-01-preview, 2020-04-01-preview, 2020-06-01, 2020-10-15-preview, 2021-06-01-preview, 2021-12-01, 2021-10-15-preview, 2022-06-15'." |
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
Swagger Generation Artifacts
|
|
Hi, @ahamad-MS your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Generated ApiView
|
ghost
added
the
|
Hi, @ahamad-MS, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
|
Hi @ahamad-MS, Your PR has some issues. Please fix the CI sequentially by following the order of
|
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Hi @ahamad-MS, 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. |
AzureRestAPISpecReview
removed
the
BreakingChangeReviewRequired
|
Notes to reviewers:
|
|
Approved Avocado and Lintdiff errors as they have been reviewd and approved in pr https://github.com/Azure/azure-rest-api-specs-pr/pull/12366. |
zedy-wj
added
the
Approved-OkToMerge
@josefree Could you help to check if it is OK to make exception for the API Readiness check failure for this case? |
As long as PR initiator confirms the API or API version is publicly available. @ahamad-MS would you confirm we can neglect the API readiness check failure? |
We are available in Central US EUAP, East US 2 EAUP, West US 3 and East US 2. We are deploying to other regions as we speak and will be available in all regions before Build. We also requested an expedited deployment for ARM manifest. So, yes, we are publicly available in some regions and in progress to be available everywhere else. |
ARM API Information (Control Plane)
Note to reviewers:
This PR was already reviewed and approved and marked as Approved-OkToMerge in Private repro azure-rest-api-specs-pr by this Pull Request here: https://github.com/Azure/azure-rest-api-specs-pr/pull/12366
However, there are few differences here between the private version and this one:
First commit of this PR is using latest preview API version 2021-10-15-preview as baseline for the changes.
https://github.com/Azure/azure-rest-api-specs-pr/pull/12366
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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:
05/10/2023
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
05/16/2023
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
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.
-[X] 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.