Adding new API version 2022-11-01-preview #21508
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
|
Hi, @vikramadityab72 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
|
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| iothub.json | 2022-11-01-preview(c59d3e1) | 2021-07-02(main) |
| iothub.json | 2022-11-01-preview(c59d3e1) | 2022-04-30-preview(main) |
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-11 | package-preview-2022-11(c59d3e1) | package-preview-2022-11(dev-iothub-Microsoft.Devices-2022-11-01-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Devices/preview/2022-11-01-preview/iothub.json#L2468 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️⌛PR Summary pending [Detail]
Swagger Generation Artifacts
|
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=331431&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 128 " |
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json warn File azure-sdk-for-net_tmp/initOutput.json not found to read command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
️✔️Azure.ResourceManager.IotHub [View full logs] [Release SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
command 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] cmderr [automation_generate.sh] npm notice New major version of npm available! 8.19.2 -> 9.1.1 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.1.1> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-iothub [View full logs] [Release SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
command ./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 available: 22.3 -> 22.3.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip available: 22.3 -> 22.3.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 warn No file changes detected after generation warn No package detected after generation
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
command 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/iothub/armiothub [View full logs] [Release SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - New const `RoutingSourceMqttBrokerMessages` info [Changelog] - New const `RoutingSourceDigitalTwinChangeEvents` info [Changelog] - New struct `EncryptionPropertiesDescription` info [Changelog] - New struct `KeyVaultKeyProperties` info [Changelog] - New struct `PropertiesDeviceStreams` info [Changelog] - New struct `RootCertificateProperties` info [Changelog] - New struct `RoutingCosmosDBSQLAPIProperties` info [Changelog] - New field `DeviceStreams` in struct `Properties` info [Changelog] - New field `Encryption` in struct `Properties` info [Changelog] - New field `RootCertificate` in struct `Properties` info [Changelog] - New field `AllowDataPlanePreviewFeatures` in struct `Properties` info [Changelog] - New field `CosmosDBSQLCollections` in struct `RoutingEndpoints` info [Changelog] info [Changelog] Total 0 breaking change(s), 14 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
command 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-iothub [View full logs] [Release SDK Changes]info [Changelog] **Features** info [Changelog] info [Changelog] - Added Interface EncryptionPropertiesDescription info [Changelog] - Added Interface IotHubManualFailoverHeaders info [Changelog] - Added Interface IotHubPropertiesDeviceStreams info [Changelog] - Added Interface IotHubResourceCreateOrUpdateHeaders info [Changelog] - Added Interface IotHubResourceDeleteHeaders info [Changelog] - Added Interface IotHubResourceUpdateHeaders info [Changelog] - Added Interface KeyVaultKeyProperties info [Changelog] - Added Interface PrivateEndpointConnectionsDeleteHeaders info [Changelog] - Added Interface PrivateEndpointConnectionsUpdateHeaders info [Changelog] - Added Interface RootCertificateProperties info [Changelog] - Added Interface RoutingCosmosDBSqlApiProperties info [Changelog] - Interface IotHubProperties has a new optional parameter allowDataPlanePreviewFeatures info [Changelog] - Interface IotHubProperties has a new optional parameter deviceStreams info [Changelog] - Interface IotHubProperties has a new optional parameter encryption info [Changelog] - Interface IotHubProperties has a new optional parameter rootCertificate info [Changelog] - Interface RoutingEndpoints has a new optional parameter cosmosDBSqlCollections info [Changelog] - Add parameters of IotHubResourceUpdateHeaders to TypeAlias IotHubResourceUpdateResponse info [Changelog] - Enum KnownRoutingSource has a new value DigitalTwinChangeEvents info [Changelog] - Enum KnownRoutingSource has a new value MqttBrokerMessages
️⚠️ azure-resource-manager-schemas warning [Detail]
command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile 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
️✔️iothub [View full logs] [Release Schema Changes]
️❌ azure-powershell failed [Detail]
command 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
❌Az.iothub [View full logs] [Release SDK Changes]
Generated ApiView
|
ghost
added
the
|
Hi @vikramadityab72, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Nov 10, 2022
[AutoPR @azure/arm-iothub] Adding new API version 2022-11-01-preview
azure-sdk/azure-sdk-for-js#2851
Closed
rkmanda
reviewed
Nov 11, 2022
| @@ -1735,6 +1735,12 @@ | |||
| "description": "Long running manual failover operation for the IoT hub completed" | |||
| }, | |||
| "202": { | |||
| "headers": { | |||
| "Azure-AsyncOperation": { | |||
|
Hi @vikramadityab72, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. |
vikramadityab72
merged commit 0b16a99
into
dev-iothub-Microsoft.Devices-2022-11-01-preview
This was referenced Nov 14, 2022
This was referenced Nov 14, 2022
Closed
Closed
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.
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:
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.
-[ ] 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.