-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add x-ms-identifiers for iothub #19969
Conversation
Hi, @j-zhong-ms 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 |
Swagger Validation Report
|
compared swaggers (via Oad v0.9.7)] | new version | base version |
---|---|---|
iothub.json | 2021-07-02(b29178d) | 2021-07-02(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2021-07-02 | package-2021-07-02(b29178d) | package-2021-07-02(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L3156 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L76 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L302 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L343 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L387 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L431 |
R3021 - PathResourceTypeNameCamelCase |
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-02/iothub.json#L478 |
R3021 - PathResourceTypeNameCamelCase |
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-02/iothub.json#L532 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L709 |
R3021 - PathResourceTypeNameCamelCase |
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-02/iothub.json#L756 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L807 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L854 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L1000 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L1067 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L1134 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L1181 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L1232 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/importDevices' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L1285 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L1338 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L1382 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/generateVerificationCode' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L1548 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/verify' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L1602 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/failover' Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L1665 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L64 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L110 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L175 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L292 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L330 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L374 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Devices/stable/2021-07-02/iothub.json#L421 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 75 Errors, 0 Warnings failed [Detail]
Test run on tag: package-2021-07-02, operation coverage: 38/38, failed operations: 28Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: subscriptionid" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: resourcegroup" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: cosmosDBSqlCollections" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: azureDigitalTwinsInstances" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: subscriptionid" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: resourcegroup" |
CLIENT_ERROR |
"statusCode: 404, errorCode: undefined, errorMessage: undefined" |
ASSERTION_ERROR |
"expected response code to be 2XX but found 404" |
INVALID_TYPE |
"Expected type string but found type integer" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: subscriptionid" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: resourcegroup" |
CLIENT_ERROR |
"statusCode: 404, errorCode: undefined, errorMessage: undefined" |
ASSERTION_ERROR |
"expected response code to be 2XX but found 404" |
INVALID_TYPE |
"Expected type string but found type integer" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Devices/IotHubs/iothubnamef2sg7n' under resource group 'apiTest-zbvxyc' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
ASSERTION_ERROR |
"expected response code to be 2XX but found 404" |
INVALID_CONTENT_TYPE |
"Invalid Content-Type (application/json). These are supported: " |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: error" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: subscriptionid" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: resourcegroup" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: subscriptionid" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: resourcegroup" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Devices/IotHubs/iothubnamef2sg7n' under resource group 'apiTest-zbvxyc' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
ASSERTION_ERROR |
"expected response code to be 2XX but found 404" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: error" |
SERVER_ERROR |
"statusCode: 500, errorCode: undefined, errorMessage: undefined" |
ASSERTION_ERROR |
"expected response code to be 2XX but found 500" |
INVALID_TYPE |
"Expected type string but found type integer" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Devices/IotHubs/iothubnamef2sg7n' under resource group 'apiTest-zbvxyc' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
ASSERTION_ERROR |
"expected response code to be 2XX but found 404" |
️❌
ModelValidation: 7 Errors, 0 Warnings failed [Detail]
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️
SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/b29178dec655cc41f2d2b591d8acf2a9439ee5bf/specification/iothub/resource-manager/readme.md#tag-package-2021-07-02">iothub/resource-manager/readme.md#package-2021-07-02
Rule | Message |
---|---|
"readme":"iothub/resource-manager/readme.md", "tag":"package-2021-07-02", "details":"The schema 'components·11psznm·schemas·eventhubconsumergroupinfo·properties·properties·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-02/iothub.json#/components/schemas/components·11psznm·schemas·eventhubconsumergroupinfo·properties·properties·additionalproperties" |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
"readme":"iothub/resource-manager/readme.md", "tag":"package-2021-07-02", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️
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).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
Hi @j-zhong-ms, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Generated ApiView
|
Hello @honghr Coud you please review this pr? This should not be a breaking change |
Hi @rkmanda could you please review this pr? This code change is not breaking |
Could you resolve "Swagger ModelValidation" issue firstly? |
Hi @honghr could you please help get this pr merged? Thanks! The error should not come from the code change |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Hi @j-zhong-ms You still have model validation error not fixed. Please resolve this issue and then I can merge it. |
Hi, @j-zhong-ms. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
About this Change
APIs will need to start indicating item uniqueness in arrays. By default, uniqueness is the string property called "id" of items in an array. When that property does not exist, the x-ms-identifiers extension property must be used to specify the identifying property(s) or lack thereof. This pull request is my best guess effort to ease resource providers into the new requirement before it becomes enforced. Compliance and accuracy will need to be owned and maintained by the resource provider going forward.
See https://github.com/Azure/autorest/tree/main/docs/extensions#x-ms-identifiers.
You can also make changes after this PR is checked in. At this point, this annotation is only used by Change Analysis for change computation, so making changes afterwards shouldn’t be a breaking change.
2. 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.
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- [ ] SDK of .NET (need service team to ensure code readiness)
- [ ] SDK of Python
- [ ] SDK of Java
- [ ] SDK of Js
- [ ] SDK of Go
- [ ] PowerShell
- [ ] CLI
- [ ] Terraform
- [x] No refresh required for updates in this PR
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 appy 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 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.