2021 preview eh #13218
Merged
2021 preview eh #13218
Conversation
This file contains hidden or 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
|
Hi, @apraovjr 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] |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'EHNamespace', must have a list by immediate parent operation. Location: Microsoft.EventHub/preview/2021-01-01-preview/CheckNameAvailability.json#L83 |
|
| The child tracked resource, 'eventhubs' with immediate parent 'EHNamespace', must have a list by immediate parent operation. Location: Microsoft.EventHub/preview/2021-01-01-preview/CheckNameAvailability.json#L83 |
|
| The child tracked resource, 'disasterRecoveryConfigs' with immediate parent 'EHNamespace', must have a list by immediate parent operation. Location: Microsoft.EventHub/preview/2021-01-01-preview/CheckNameAvailability.json#L83 |
|
| The child tracked resource, 'authorizationRules' with immediate parent 'EHNamespace', must have a list by immediate parent operation. Location: Microsoft.EventHub/preview/2021-01-01-preview/CheckNameAvailability.json#L83 |
|
| The child tracked resource, 'authorizationRules' with immediate parent 'ArmDisasterRecovery', must have a list by immediate parent operation. Location: Microsoft.EventHub/preview/2021-01-01-preview/CheckNameAvailability.json#L83 |
|
| The child tracked resource, 'authorizationRules' with immediate parent 'Eventhub', must have a list by immediate parent operation. Location: Microsoft.EventHub/preview/2021-01-01-preview/CheckNameAvailability.json#L83 |
|
| The child tracked resource, 'consumergroups' with immediate parent 'Eventhub', must have a list by immediate parent operation. Location: Microsoft.EventHub/preview/2021-01-01-preview/CheckNameAvailability.json#L83 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: requireInfrastructureEncryption Location: Microsoft.EventHub/preview/2021-01-01-preview/namespaces-preview.json#L798 |
|
| 'identity' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.EventHub/preview/2021-01-01-preview/namespaces-preview.json#L822 |
|
| 'userAssignedIdentityProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.EventHub/preview/2021-01-01-preview/namespaces-preview.json#L986 |
️️✔️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): 1 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.8.6)
- original: preview/2018-01-01-preview/AuthorizationRules.json <---> new: preview/2021-01-01-preview/AuthorizationRules.json
- original: preview/2018-01-01-preview/CheckNameAvailability.json <---> new: preview/2021-01-01-preview/CheckNameAvailability.json
- original: preview/2018-01-01-preview/consumergroups.json <---> new: preview/2021-01-01-preview/consumergroups.json
- original: preview/2018-01-01-preview/disasterRecoveryConfigs.json <---> new: preview/2021-01-01-preview/disasterRecoveryConfigs.json
- original: preview/2018-01-01-preview/eventhubs.json <---> new: preview/2021-01-01-preview/eventhubs.json
- original: preview/2018-01-01-preview/namespaces-preview.json <---> new: preview/2021-01-01-preview/namespaces-preview.json
- original: preview/2018-01-01-preview/networkrulessets-preview.json <---> new: preview/2021-01-01-preview/networkrulessets-preview.json
- original: preview/2018-01-01-preview/operations.json <---> new: preview/2021-01-01-preview/operations.json
| Rule | Message |
|---|---|
| The new version has a different default value than the previous one. New: Microsoft.EventHub/preview/2021-01-01-preview/namespaces-preview.json#L737:9 Old: Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json#L729:9 |
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
- Compared Swaggers (Based on Oad v0.8.6)
- original: stable/2017-04-01/AuthorizationRules.json <---> new: preview/2021-01-01-preview/AuthorizationRules.json
- original: stable/2017-04-01/CheckNameAvailability.json <---> new: preview/2021-01-01-preview/CheckNameAvailability.json
- original: stable/2017-04-01/consumergroups.json <---> new: preview/2021-01-01-preview/consumergroups.json
- original: stable/2017-04-01/disasterRecoveryConfigs.json <---> new: preview/2021-01-01-preview/disasterRecoveryConfigs.json
- original: stable/2017-04-01/eventhubs.json <---> new: preview/2021-01-01-preview/eventhubs.json
- original: stable/2017-04-01/operations.json <---> new: preview/2021-01-01-preview/operations.json
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 44 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"eventhub/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"The schema 'EHNamespaceListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventhub/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"The schema 'EHNamespace' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventhub/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"The schema 'EHNamespace-properties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventhub/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"The schema 'Identity' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventhub/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"The schema 'Encryption' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventhub/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"The schema 'KeyVaultProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventhub/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"The schema 'PrivateEndpointConnection' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventhub/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"The schema 'PrivateEndpointConnectionProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventhub/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"The schema 'PrivateEndpoint' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventhub/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"The schema 'ConnectionState' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=199394&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 " |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @apraovjr your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @ruowan |
Contributor
Author
|
@chiragg4u For review and approval |
This was referenced Mar 2, 2021
chiragg4u
reviewed
Mar 2, 2021
| } | ||
| } | ||
| }, | ||
| "systemData": { |
Contributor
There was a problem hiding this comment.
systemData [](start = 5, length = 10)
Recommend referring to common definitions "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/..." instead of copying it to local common files
chiragg4u
added
ARMSignedOff
Contributor
Author
|
@weidongxu-microsoft for review and approval |
Member
|
It seems that the PR will cause huge breaking change. Is it expected? info [Changelog] Features |
Contributor
Author
|
When the RP first released support for IPFiltering and VirtualNetworks features in API version 2018-01-01-preview, We added it as resource type i.e. IPFilter resource is represented as both Microsoft.EventHub/namespaces/IpFilterRules and Microsoft.EventHub/namespaces/networkRuleSets.ipRules and VirtualNetworks resources is represented as both Microsoft.EventHub/namespaces/VirtualNetworkRules and Microsoft.EventHub/namespaces/networkRuleSets.virtualNetworkRules All the client APIs / Portals only use Microsoft.EventHub/namespaces/VirtualNetworkRules. To avoid confusion to our customers because of having two way of configuring IPFilters and VirtualNetworks, We are going to not take Microsoft.EventHub/namespaces/IpFilterRules and Microsoft.EventHub/namespaces/VirtualNetworkRules to the 2021-01-01-preview API version. CheckNameAvailability will be added to 2021-01-01-preview. That was a miss |
|
Hi @apraovjr, Your PR has some issues. Please fix the CI sequentially by following the order of
|
msyyc
approved these changes
Mar 10, 2021
Contributor
Author
This was referenced Mar 12, 2021
Closed
MirzaSikander
pushed a commit
to MirzaSikander/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2021
* Add 2018 files as base commit * Change files for 2021 in base files * Add privatendpoint property and refresh the get example response * Add checknamespaceavailability 2018 base file * change file checknameavailability for 2021-preview
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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 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.