Event Grid: add support for 2021-10-15-preview API version #18349
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
Brandon411
requested review from
msyyc,
BigCat20196,
ArcturusZhang,
Kishp01 and
ahamad-MS
as code owners
|
Hi, @Brandon411 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 |
|
[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 |
|---|---|
| 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. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L4372 |
|
| Since operation 'DomainTopicEventSubscriptions_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. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L4431 |
|
| Since operation 'TopicEventSubscriptions_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. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L4497 |
|
| Since operation 'DomainEventSubscriptions_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. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L4556 |
|
| OperationId should contain the verb: 'listkeys' in:'PartnerNamespaces_ListSharedAccessKeys'. Consider updating the operationId Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L5798 |
|
| The child tracked resource, 'eventSubscriptions' with immediate parent 'Domain', must have a list by immediate parent operation. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10494 |
|
| The child tracked resource, 'eventSubscriptions' with immediate parent 'PartnerTopic', must have a list by immediate parent operation. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10494 |
|
| Guid used in model definition 'Partner' for property 'partnerRegistrationImmutableId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10722 |
|
| Guid used in model definition 'PartnerDestinationProperties' for property 'partnerRegistrationImmutableId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10821 |
|
| Guid used in model definition 'PartnerRegistrationProperties' for property 'partnerRegistrationImmutableId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L11139 |
|
| Guid used in model definition 'PartnerTopicProperties' for property 'partnerRegistrationImmutableId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L11344 |
|
| Guid used in model definition 'VerifiedPartnerProperties' for property 'partnerRegistrationImmutableId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L12043 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAdvancedFilteringOnArrays Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L9400 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10640 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10983 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L11068 |
|
| 'PartnerEventSubscriptionDestinationProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10441 |
|
| 'PartnerEventSubscriptionDestination' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10450 |
|
| 'privateEndpointConnections' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10929 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L12011 |
|
The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L6689 |
|
The response of operation:'PrivateEndpointConnections_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L6762 |
|
The response of operation:'TopicTypes_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L8085 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L6909 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L7631 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10060 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10231 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10301 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10335 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10369 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10415 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10602 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10615 |
| 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. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L4263 |
|
| 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. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L4313 |
|
| 'PUT' operation 'PrivateEndpointConnections_Update' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L6768 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L7868 |
|
| OperationId should contain the verb: 'listkeys' in:'Domains_ListSharedAccessKeys'. Consider updating the operationId Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L739 |
|
| OperationId should contain the verb: 'listkeys' in:'Topics_ListSharedAccessKeys'. Consider updating the operationId Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L7823 |
|
| The child tracked resource, 'topics' with immediate parent 'Domain', must have a list by immediate parent operation. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L9269 |
|
| The child tracked resource, 'eventSubscriptions' with immediate parent 'SystemTopic', must have a list by immediate parent operation. Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L10494 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L8745 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoCreateTopicWithFirstSubscription Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L8750 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoDeleteTopicWithLastSubscription Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L8755 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L9176 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoCreateTopicWithFirstSubscription Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L9180 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoDeleteTopicWithLastSubscription Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L9184 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: value Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L9532 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isSubjectCaseSensitive Location: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L9953 |
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag does not contain all APIs in this RP. 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 |
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 3 Errors, 7 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:preview/2021-10-15-preview/EventGrid.json compared with base:stable/2020-06-01/EventGrid.json
- current:preview/2021-10-15-preview/EventGrid.json compared with base:preview/2021-06-01-preview/EventGrid.json
| Rule | Message |
|---|---|
|
The new version adds a response code '202'. New: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L7920:11 |
|
The read only property has changed from 'true' to 'false'. New: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L9278:9 Old: Microsoft.EventGrid/stable/2020-06-01/EventGrid.json#L3223:9 |
|
The read only property has changed from 'true' to 'false'. New: Microsoft.EventGrid/preview/2021-10-15-preview/EventGrid.json#L9246:5 Old: Microsoft.EventGrid/stable/2020-06-01/EventGrid.json#L3190:5 |
The following breaking changes are detected by comparison with latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
Swagger Generation Artifacts
|
|
Hi, @Brandon411 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi @Brandon411, Your PR has some issues. Please fix the CI sequentially by following the order of
|
pilor
added
ARMSignedOff
|
Signing off from the API side due to all changes being previously approved in the private repo. If that is not actually the case please let me know. |
This was referenced Mar 22, 2022
Comment on lines
7795
to
12089
| ], | ||
| "summary": "List keys for a topic.", | ||
| "description": "List the two keys used to publish to a topic.", | ||
| "operationId": "Topics_ListSharedAccessKeys", | ||
|
|
There was a problem hiding this comment.
I saw these places are reported in azure-sdk-for-go pipeline.
This might not be OK - I never saw this kind of expression of a parameter.
Could you please remove these two parameter definitions, and insert the "ref" here inline at every place previously referencing these two parameters?
There was a problem hiding this comment.
This parameter has been addressed
This was referenced Mar 23, 2022
Comment on lines
7787
to
12105
| } | ||
| }, | ||
| "x-ms-pageable": { | ||
| "nextLinkName": "nextLink" | ||
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/listKeys": { | ||
| "post": { | ||
| "tags": [ | ||
| "Topics" | ||
| ], | ||
| "summary": "List keys for a topic.", | ||
| "description": "List the two keys used to publis |
There was a problem hiding this comment.
So you changed this back...actually this is not what I am expecting...
I would like that we still use the subscriptionId and apiVersion parameter from common-types, instead of defining these in this swagger.
Could you please do a replace in this file from "#/parameters/SubscriptionIdParameter" to `"../../../common-types/types/v3/..../SusbcriptionIdParameter" and the same for apiVersionParameter?
There was a problem hiding this comment.
We will address this separately in next PR.
|
@jianyexi to take a look cross API version breaking change about readonly change. looks it is false alarm |
|
|
The PR has 2 Linter issue which must be fixed: |
|
Looks all of x-ms-identify is put as empty, consider you are urgent and it is not related with SDK generation, you can put correct id in another PR in the future. so I will merge first |
This was referenced Mar 26, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Mar 26, 2022
visingl
pushed a commit
that referenced
this pull request
Mar 30, 2022
* Using 2021-06-01-preview files as a baseline * Add swagger, example, and readme files for 2021-10-15-preview API version * Fix prettier errors and missing files * Fix Python readme file * Remove references to common-types files * Fix missing brace in example file * Fix ModelValidation errors * Fix more ModelValidation errors * Fix more ModelValidation errors * Make systemData read only * Run prettier for Channels_Update.json * Fix various linter errors * Data residency boundary fix
25 tasks
FredericHeem
pushed a commit
to grucloud/azure-rest-api-specs
that referenced
this pull request
May 16, 2022
* Using 2021-06-01-preview files as a baseline * Add swagger, example, and readme files for 2021-10-15-preview API version * Fix prettier errors and missing files * Fix Python readme file * Remove references to common-types files * Fix missing brace in example file * Fix ModelValidation errors * Fix more ModelValidation errors * Fix more ModelValidation errors * Make systemData read only * Run prettier for Channels_Update.json * Fix various linter errors * Data residency boundary fix
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.
In this PR, we are adding support for the new API version 2021-10-15-preview. All of the changes in this PR were already approved in a previous PR to the private repo. These PRs are:
The changes in this PR includes, but is not limited to:
Changelog
Add a changelog entry for 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
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the 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.