azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
[EventHub] Correcting Swagger files for EventHub to improve Correctness
ARM API Information (Control Plane)
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:
- What's the purpose of the update?
- [ ] new service onboarding
- [ ] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
- 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):
- [ ] I commit to follow the Breaking Change Policy of "no breaking changes"
- [ ] I have reviewed the documentation for the workflow.
- [ ] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
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.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] 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.
Hi, @schaudhari6254888 Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 27 Errors, 0 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| Clusters-preview.json | 2018-01-01-preview(7d567e4) | 2018-01-01-preview(main) |
| disasterRecoveryConfigs.json | 2018-01-01-preview(7d567e4) | 2018-01-01-preview(main) |
| namespaces-preview.json | 2018-01-01-preview(7d567e4) | 2018-01-01-preview(main) |
| networkrulessets-preview.json | 2018-01-01-preview(7d567e4) | 2018-01-01-preview(main) |
| disasterRecoveryConfigs.json | 2021-01-01-preview(7d567e4) | 2021-01-01-preview(main) |
| namespaces-preview.json | 2021-01-01-preview(7d567e4) | 2021-01-01-preview(main) |
| networkrulessets-preview.json | 2021-01-01-preview(7d567e4) | 2021-01-01-preview(main) |
| Clusters-preview.json | 2021-06-01-preview(7d567e4) | 2021-06-01-preview(main) |
| disasterRecoveryConfigs.json | 2021-06-01-preview(7d567e4) | 2021-06-01-preview(main) |
| namespaces-preview.json | 2021-06-01-preview(7d567e4) | 2021-06-01-preview(main) |
| networkrulessets-preview.json | 2021-06-01-preview(7d567e4) | 2021-06-01-preview(main) |
| Clusters-preview.json | 2022-01-01-preview(7d567e4) | 2022-01-01-preview(main) |
| disasterRecoveryConfigs.json | 2022-01-01-preview(7d567e4) | 2022-01-01-preview(main) |
| namespaces-preview.json | 2022-01-01-preview(7d567e4) | 2022-01-01-preview(main) |
| networkrulessets-preview.json | 2022-01-01-preview(7d567e4) | 2022-01-01-preview(main) |
| Clusters-preview.json | 2022-10-01-preview(7d567e4) | 2022-10-01-preview(main) |
| disasterRecoveryConfigs.json | 2022-10-01-preview(7d567e4) | 2022-10-01-preview(main) |
| eventhubs.json | 2022-10-01-preview(7d567e4) | 2022-10-01-preview(main) |
| namespaces-preview.json | 2022-10-01-preview(7d567e4) | 2022-10-01-preview(main) |
| networkrulessets-preview.json | 2022-10-01-preview(7d567e4) | 2022-10-01-preview(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️🔄LintDiff inProgress [Detail]
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 21 Errors, 0 Warnings failed [Detail]
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌ azure-sdk-for-net-track2 failed [Detail]
❌Failed [Logs] Generate from ab90e200bf842888495043bc0d1869c938003e5a. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:712 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 712 | [0m [36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m … cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m | [31;1mFailed to build sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] [0m
❌Azure.ResourceManager.EventHubs [View full logs] [Preview SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from ab90e200bf842888495043bc0d1869c938003e5a. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] npm notice cmderr [automation_generate.sh] npm notice New minor version of npm available! 9.6.7 -> 9.8.1 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-eventhub [View full logs] [Preview SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - Model ArmDisasterRecovery has a new parameter type_properties_type info [Changelog] - Model Cluster has a new parameter provisioning_state info [Changelog] - Model NetworkSecurityPerimeterConfiguration has a new parameter location info [Changelog] - Model PrivateEndpointConnection has a new parameter group_id
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from ab90e200bf842888495043bc0d1869c938003e5a. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-eventhubs-generated [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from ab90e200bf842888495043bc0d1869c938003e5a. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/eventhub/armeventhub [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - `CleanupPolicyRetentionDescriptionCompaction` from enum `CleanupPolicyRetentionDescription` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New value `CleanupPolicyRetentionDescriptionCompact` added to enum type `CleanupPolicyRetentionDescription` info [Changelog] - New enum type `ProvisioningState` with values `ProvisioningStateActive`, `ProvisioningStateCanceled`, `ProvisioningStateCreating`, `ProvisioningStateDeleting`, `ProvisioningStateFailed`, `ProvisioningStateScaling`, `ProvisioningStateSucceeded`, `ProvisioningStateUnknown` info [Changelog] - New enum type `Type` with values `TypeMetadataReplication` info [Changelog] - New field `Type` in struct `ArmDisasterRecoveryProperties` info [Changelog] - New field `ProvisioningState` in struct `ClusterProperties` info [Changelog] - New field `Location` in struct `NetworkSecurityPerimeterConfiguration` info [Changelog] - New field `GroupID` in struct `PrivateEndpointConnectionProperties` info [Changelog] info [Changelog] Total 1 breaking change(s), 16 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from ab90e200bf842888495043bc0d1869c938003e5a. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
️✔️@azure/arm-eventhub [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added operation group ApplicationGroupOperations info [Changelog] - Added operation group NetworkSecurityPerimeterConfigurationOperations info [Changelog] - Added operation group NetworkSecurityPerimeterConfigurations info [Changelog] - Added Interface ApplicationGroup info [Changelog] - Added Interface ApplicationGroupCreateOrUpdateApplicationGroupOptionalParams info [Changelog] - Added Interface ApplicationGroupDeleteOptionalParams info [Changelog] - Added Interface ApplicationGroupGetOptionalParams info [Changelog] - Added Interface ApplicationGroupListByNamespaceNextOptionalParams info [Changelog] - Added Interface ApplicationGroupListByNamespaceOptionalParams info [Changelog] - Added Interface ApplicationGroupListResult info [Changelog] - Added Interface ApplicationGroupPolicy info [Changelog] - Added Interface NetworkSecurityPerimeter info [Changelog] - Added Interface NetworkSecurityPerimeterConfiguration info [Changelog] - Added Interface NetworkSecurityPerimeterConfigurationList info [Changelog] - Added Interface NetworkSecurityPerimeterConfigurationListOptionalParams info [Changelog] - Added Interface NetworkSecurityPerimeterConfigurationPropertiesProfile info [Changelog] - Added Interface NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation info [Changelog] - Added Interface NetworkSecurityPerimeterConfigurationsCreateOrUpdateOptionalParams info [Changelog] - Added Interface NspAccessRule info [Changelog] - Added Interface NspAccessRuleProperties info [Changelog] - Added Interface NspAccessRulePropertiesSubscriptionsItem info [Changelog] - Added Interface ProvisioningIssue info [Changelog] - Added Interface ProvisioningIssueProperties info [Changelog] - Added Interface RetentionDescription info [Changelog] - Added Interface ThrottlingPolicy info [Changelog] - Added Type Alias ApplicationGroupCreateOrUpdateApplicationGroupResponse info [Changelog] - Added Type Alias ApplicationGroupGetResponse info [Changelog] - Added Type Alias ApplicationGroupListByNamespaceNextResponse info [Changelog] - Added Type Alias ApplicationGroupListByNamespaceResponse info [Changelog] - Added Type Alias ApplicationGroupPolicyType info [Changelog] - Added Type Alias ApplicationGroupPolicyUnion info [Changelog] - Added Type Alias CleanupPolicyRetentionDescription info [Changelog] - Added Type Alias MetricId info [Changelog] - Added Type Alias NetworkSecurityPerimeterConfigurationListResponse info [Changelog] - Added Type Alias NetworkSecurityPerimeterConfigurationProvisioningState info [Changelog] - Added Type Alias NspAccessRuleDirection info [Changelog] - Added Type Alias ProvisioningState info [Changelog] - Added Type Alias PublicNetworkAccess info [Changelog] - Added Type Alias ResourceAssociationAccessMode info [Changelog] - Added Type Alias TlsVersion info [Changelog] - Added Type Alias Type info [Changelog] - Interface ArmDisasterRecovery has a new optional parameter typePropertiesType info [Changelog] - Interface Cluster has a new optional parameter provisioningState info [Changelog] - Interface Cluster has a new optional parameter supportsScaling info [Changelog] - Interface EHNamespace has a new optional parameter minimumTlsVersion info [Changelog] - Interface EHNamespace has a new optional parameter publicNetworkAccess info [Changelog] - Interface Eventhub has a new optional parameter retentionDescription info [Changelog] - Interface PrivateEndpointConnection has a new optional parameter groupId info [Changelog] - Added Enum KnownApplicationGroupPolicyType info [Changelog] - Added Enum KnownCleanupPolicyRetentionDescription info [Changelog] - Added Enum KnownMetricId info [Changelog] - Added Enum KnownNetworkSecurityPerimeterConfigurationProvisioningState info [Changelog] - Added Enum KnownNspAccessRuleDirection info [Changelog] - Added Enum KnownProvisioningState info [Changelog] - Added Enum KnownPublicNetworkAccess info [Changelog] - Added Enum KnownResourceAssociationAccessMode info [Changelog] - Added Enum KnownTlsVersion info [Changelog] - Added Enum KnownType info [Changelog] - Enum KnownPublicNetworkAccessFlag has a new value SecuredByPerimeter info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Interface ConsumerGroupsListByEventHubNextOptionalParams no longer has parameter skip info [Changelog] - Interface ConsumerGroupsListByEventHubNextOptionalParams no longer has parameter top info [Changelog] - Interface EventHubsListByNamespaceNextOptionalParams no longer has parameter skip info [Changelog] - Interface EventHubsListByNamespaceNextOptionalParams no longer has parameter top info [Changelog] - Interface SchemaRegistryListByNamespaceNextOptionalParams no longer has parameter skip info [Changelog] - Interface SchemaRegistryListByNamespaceNextOptionalParams no longer has parameter top
️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from ab90e200bf842888495043bc0d1869c938003e5a. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json warn File azure-resource-manager-schemas_tmp/initOutput.json not found to read command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
️✔️eventhub [View full logs] [Preview Schema Changes]
️❌ azure-powershell failed [Detail]
❌Pipeline Framework Failed [Logs] Generate from ab90e200bf842888495043bc0d1869c938003e5a. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json SSL error: syscall failure: Broken pipe Error: SSL error: syscall failure: Broken pipe
️✔️Az.eventhub.DefaultTag [View full logs]error Fatal error: SSL error: syscall failure: Broken pipe error The following packages are still pending: error Az.eventhub.DefaultTag
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | Microsoft.EventHub | Create ApiView failed. Please ask PR assignee for help |
| Go | sdk/resourcemanager/eventhub/armeventhub | https://apiview.dev/Assemblies/Review/a3cde08105f74f8bb28882df7a6e673f |
| Java | azure-resourcemanager-eventhubs-generated | https://apiview.dev/Assemblies/Review/d811d9c00c7248439d69781a641ae171 |
| .Net | Azure.ResourceManager.EventHubs | https://apiview.dev/Assemblies/Review/5ac342b5859f4ea5b3ae0f07d5b0e057 |
| JavaScript | @azure/arm-eventhub | https://apiview.dev/Assemblies/Review/37074fe601f447549bdd27684dfe6b9c |
Hi @schaudhari6254888, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
NewApiVersionRequired reason: A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support. EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.
Hi @schaudhari6254888! The automation detected breaking changes in this pull request. As a result, it added the BreakingChangeReviewRequired label.
You cannot proceed with merging this PR until you complete one of the following action items:
ACTION ITEM ALTERNATIVE A: Fix the breaking change.
Please consult the documentation provided in the relevant validation failures.
ACTION ITEM ALTERNATIVE B: Request approval.
Alternatively, if you cannot fix the breaking changes, then you can request an approval for them. Please follow the process described in the High-level Breaking Change Process doc.
ACTION ITEM ALTERNATIVE C: Report false positive.
If you think there are no breaking changes, i.e. the validation should pass yet it fails, then proceed as explained in ACTION ITEM ALTERNATIVE B.
This applies even if the breaking change tool fails with internal runtime error. In such case a manual breaking change review is necessary.