EventGrid - Add api-version 2020-10-15-preview #11879
Merged
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
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Since operation 'EventSubscriptions_GetDeliveryAttributes' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L2642 |
|
| Since operation 'SystemTopicEventSubscriptions_GetDeliveryAttributes' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L2692 |
|
| Since operation 'PartnerTopicEventSubscriptions_GetDeliveryAttributes' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L2751 |
|
| The operation 'PartnerRegistrations_CreateOrUpdate' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L3341 |
|
| The operation 'PartnerRegistrations_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L3408 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L5200 |
|
| The summary and description values should not be same. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L1344 |
|
| The summary and description values should not be same. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L1405 |
|
| The summary and description values should not be same. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L1655 |
|
| The summary and description values should not be same. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L1781 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️[Staging] Cross Version BreakingChange (Base on preview version): 6 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.8.6)
- original: preview/2020-04-01-preview/EventGrid.json <---> new: preview/2020-10-15-preview/EventGrid.json
| Rule | Message |
|---|---|
| The new version adds a response code '200'. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L1385:11 |
|
| The new version adds a response code '200'. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L1822:11 |
|
| The new version adds a response code '200'. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L2988:11 |
|
| The new version adds a response code '200'. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L4624:11 |
|
| The new version adds a response code '202'. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L5252:11 |
|
| The new version adds a response code 'default'. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L5367:11 |
️⚠️[Staging] Cross Version BreakingChange (Base on stable version): 1 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.8.6)
- original: stable/2020-06-01/EventGrid.json <---> new: preview/2020-10-15-preview/EventGrid.json
| Rule | Message |
|---|---|
| The new version adds a response code '202'. New: Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json#L5252:11 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
Swagger Generation Artifacts
|
|
Hi, @batrived 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. vsswagger@microsoft.com |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @batrived your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @akning-ms |
|
LINT errors are for existing swagger definitions and I haven't made changes in that area. We have a workitem to fix the existing swagger changes, so we need exemption on this PR |
This was referenced Dec 1, 2020
j5lim
reviewed
Dec 2, 2020
...ion/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json
Show resolved
Hide resolved
j5lim
reviewed
Dec 2, 2020
There was a problem hiding this comment.
LINT errors are for existing swagger definitions and I haven't made changes in that area. We have a workitem to fix the existing swagger changes, so we need exemption on this PR
Can the errors be fixed now? It will be easier than fixing after the api-version is published. If it is time-constrained, can you please provide the work item and ETA for fixing it? Thanks.
...ion/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json
Show resolved
Hide resolved
...ion/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json
Show resolved
Hide resolved
j5lim
added
the
ARMChangesRequested
This is the workitem: https://msazure.visualstudio.com/Swagger%20KPIs/_workitems/edit/8187847 and it is marked to be done in December. |
Thanks. Submitting separate PRs is fine. I just wanted to point that fixing those later may require additional process if it is considered as a breaking change. |
j5lim
removed
the
ARMChangesRequested
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
ahamad-MS
removed
the
Reviewed-ChangesRequested
|
Hello @akning-ms all linter issues are addressed now.. Can you please help merge this PR .. thanks |
This was referenced Jan 29, 2021
Closed
11 tasks
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Committing base for the new api version * Adding api version 2020-10-15-preview * Making Topics_RegenerateKey as async operation * Fixing credscan issues * Fixing PR comments in readme.md * Adding storageQueue TTL feature and new advanced filter changes * Adding one more property for advanced filter * Added an example for AzureArc topic * Fixing the example payload * Fixing the example payload * Adding new properties to EventChannelFilter, advancedFiltering changes to support array of ranges, rename IsNull advanced filter to IsNullOrUndefined * Fix R4009 RequiredSystemDataInNewApiVersions for EventChannel operations * Fix R4009 RequiredSystemDataInNewApiVersions for EventChannel operations - fix path for systemData definitions * Fix R4009 RequiredSystemDataInNewApiVersions for EventChannel operations - remove extra element in swagger * Fix R4009 RequiredSystemDataInNewApiVersions for EventChannel operations - wrong plaqcement * Fix R4009 RequiredSystemDataInNewApiVersions for EventChannel operations - add readonly * Fix R4009 RequiredSystemDataInNewApiVersions for EventChannel operations - fix location under parent properties and fix default message * fix default message * Fix R4011 - DeleteOperationResponses * fix examples * fix example Co-authored-by: Ashraf Hamad <ahamad@ntdev.microsoft.com>
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.
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 API 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.