[Iothub] Adding new properties in IothubProperties [stable version: 2021-07-01] #14894
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, @nimengan 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] |
|
[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 |
|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isVerified Location: Microsoft.Devices/preview/2021-07-01-preview/iothub.json#L2062 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isVerified Location: Microsoft.Devices/stable/2021-07-01/iothub.json#L2062 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}' Location: Microsoft.Devices/stable/2021-07-01/iothub.json#L76 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs' Location: Microsoft.Devices/stable/2021-07-01/iothub.json#L302 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs' Location: Microsoft.Devices/stable/2021-07-01/iothub.json#L343 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats' Location: Microsoft.Devices/stable/2021-07-01/iothub.json#L387 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus' Location: Microsoft.Devices/stable/2021-07-01/iothub.json#L431 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups' Location: Microsoft.Devices/stable/2021-07-01/iothub.json#L478 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}' Location: Microsoft.Devices/stable/2021-07-01/iothub.json#L532 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs' Location: Microsoft.Devices/stable/2021-07-01/iothub.json#L708 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}' Location: Microsoft.Devices/stable/2021-07-01/iothub.json#L755 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics' Location: Microsoft.Devices/stable/2021-07-01/iothub.json#L806 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 5 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.11)
- current:stable/2021-07-01/iothub.json compared with base:preview/2021-07-01-preview/iothub.json
- current:stable/2021-07-01/iothub.json compared with base:stable/2021-03-31/iothub.json
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 2 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"iothub/resource-manager/readme.md", "tag":"package-preview-2021-07", "details":"The schema 'components·11psznm·schemas·eventhubconsumergroupinfo·properties·properties·additionalproperties' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/iothub.json#/components/schemas/components·11psznm·schemas·eventhubconsumergroupinfo·properties·properties·additionalproperties" |
|
| "readme":"iothub/resource-manager/readme.md", "tag":"package-2021-07", "details":"The schema 'components·11psznm·schemas·eventhubconsumergroupinfo·properties·properties·additionalproperties' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/iothub.json#/components/schemas/components·11psznm·schemas·eventhubconsumergroupinfo·properties·properties·additionalproperties" |
|
| 💬 AutorestCore/Exception | "readme":"iothub/resource-manager/readme.md", "tag":"package-preview-2021-07", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"iothub/resource-manager/readme.md", "tag":"package-preview-2021-07", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"iothub/resource-manager/readme.md", "tag":"package-2021-07", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"iothub/resource-manager/readme.md", "tag":"package-2021-07", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"iothub/resource-manager/readme.md",
"tag":"package-preview-2021-07",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
This was referenced Jun 18, 2021
This was referenced Jun 18, 2021
nimengan
added
WaitForARMFeedback
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @nimengan your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
|
for the cross version breaking changes, the new stable version 2021-07-01 is compared to the preview of 2021-07-01-preview.. We have more features/properties in preview version than in stable version. |
pilor
reviewed
Jun 28, 2021
specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/iothub.json
Show resolved
Hide resolved
pilor
added
ARMChangesRequested
|
@chunyu3 could you please merge the PR ? |
|
hi @nimengan There are breaking change across version. Please help to check and fix. thanks |
@chunyu3 for the cross version breaking changes, the new stable version 2021-07-01 is compared to the preview of 2021-07-01-preview.. We have more features/properties in preview version than in stable version. so these are not really breaking changes. |
|
@chunyu3 could you please merge the PR ? please let me know if you need any further information. |
|
@chunyu3 please help in merging this pull request. we are getting delayed on our feature release. Please let me know if you need any information. |
chunyu3
approved these changes
Jul 6, 2021
This was referenced Jul 6, 2021
timtay-microsoft
added a commit
to Azure/azure-sdk-for-java
that referenced
this pull request
Jul 7, 2021
Azure/azure-rest-api-specs#14894 Also adding a simple code generation script for local generation for other service API version increases later that we'll need to regenerate this SDK for
timtay-microsoft
added a commit
to Azure/azure-sdk-for-java
that referenced
this pull request
Jul 7, 2021
Azure/azure-rest-api-specs#14894 Also adding a simple code generation script for local generation for other service API version increases later that we'll need to regenerate this SDK for
timtay-microsoft
added a commit
to Azure/azure-sdk-for-java
that referenced
this pull request
Jul 7, 2021
Azure/azure-rest-api-specs#14894 Also adding a simple code generation script for local generation for other service API version increases later that we'll need to regenerate this SDK for
timtay-microsoft
added a commit
to Azure/azure-sdk-for-java
that referenced
this pull request
Jul 8, 2021
…22815) Azure/azure-rest-api-specs#14894 Also adding a simple code generation script for local generation for other service API version increases later that we'll need to regenerate this SDK for
JeffreyRichter
added
the
Approved-BreakingChange
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
…021-07-01] (Azure#14894) * Adds base for updating Microsoft.Devices from version stable/2021-03-31 to version 2021-07-01 * Updates readme * Updates API version in new specs and examples * adding new properties in iothu properties * Adding isVerified property in preview version * validation fixes
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 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.